Returns the services Resource.
+
+ skills()
+
Returns the skills Resource.
+Close httplib2 connections.
diff --git a/docs/dyn/agentregistry_v1.projects.locations.skills.html b/docs/dyn/agentregistry_v1.projects.locations.skills.html new file mode 100644 index 0000000000..52931437c8 --- /dev/null +++ b/docs/dyn/agentregistry_v1.projects.locations.skills.html @@ -0,0 +1,258 @@ + + + +
+ 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.
+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",
+ ],
+}
+Returns the indexes Resource.
+
+ interactions()
+
Returns the interactions Resource.
+ diff --git a/docs/dyn/aiplatform_v1.interactions.html b/docs/dyn/aiplatform_v1.interactions.html new file mode 100644 index 0000000000..358ac2c67a --- /dev/null +++ b/docs/dyn/aiplatform_v1.interactions.html @@ -0,0 +1,9648 @@ + + + +Cancels an interaction.
+
+ close()
Close httplib2 connections.
+
+ getPoll(name, lastEventId=None, stream=None, x__xgafv=None)
Fully typed proto, unary version of GetInteraction that returns Interaction proto.
+
+ getStream(name, lastEventId=None, stream=None, x__xgafv=None)
Fully typed proto, streaming version of GetInteraction that returns Interaction proto.
+cancel(name, x__xgafv=None)
+ Cancels an interaction.
+
+Args:
+ name: string, Required. The name of the interaction to cancel. Format: `interactions/{interaction}`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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. 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",
+ },
+ "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.
+ "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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ ],
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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.
+ },
+ },
+ ],
+ },
+ "steps": [ # Required. Output only. The steps that make up the interaction, when included in the response.
+ { # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ ],
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ },
+ "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, 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)
+ 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.
+ },
+ "document": { # A document content block.
+ "data": "A String", # The document content.
+ "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+ "uri": "A String", # The URI of the document.
+ },
+ "image": { # An image content block.
+ "data": "A String", # The image content.
+ "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+ "resolution": "A String", # The resolution of the media.
+ "uri": "A String", # The URI of the image.
+ },
+ "text": { # A text content block.
+ "annotations": [ # Citation information for model-generated content.
+ { # Citation information for model-generated content.
+ "endIndex": 42, # End of the attributed segment, exclusive.
+ "fileCitation": { # A file citation annotation. # A file citation annotation.
+ "customMetadata": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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. 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",
+ },
+ "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.
+ "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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ ],
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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.
+ },
+ },
+ ],
+ },
+ "steps": [ # Required. Output only. The steps that make up the interaction, when included in the response.
+ { # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ ],
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ },
+ "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).
+ },
+}
+getStream(name, 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)
+ 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:
+
+ {
+ "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": { # Signals that the Interaction completed. Sent when the Interaction receives Complete/Cancel or naturally terminates. No more input can be sent to the Interaction after this. # The interaction data, used for interaction.completed events. Used when steps are enabled.
+ "interaction": { # Response for InteractionService.CreateInteraction. # Required. Partial completed interaction resource emitted at the end of the stream.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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. 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",
+ },
+ "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.
+ "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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ ],
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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.
+ },
+ },
+ ],
+ },
+ "steps": [ # Required. Output only. The steps that make up the interaction, when included in the response.
+ { # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ ],
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ },
+ "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": { # Server response confirming that a new interaction was created. # The interaction data, used for interaction.created events. Used when steps are enabled.
+ "interaction": { # Response for InteractionService.CreateInteraction. # Required. Partial interaction resource emitted when the stream is created.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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. 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",
+ },
+ "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.
+ "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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ ],
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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.
+ },
+ },
+ ],
+ },
+ "steps": [ # Required. Output only. The steps that make up the interaction, when included in the response.
+ { # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ ],
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ },
+ "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",
+ "usage": { # Statistics on the interaction request's token usage. # Model usage statistics up to this checkpoint.
+ "cachedTokensByModality": [ # A breakdown of cached token usage by modality.
+ { # The token count for a single response modality.
+ "modality": "A String", # The modality associated with the token count.
+ "tokens": 42, # Number of tokens for the modality.
+ },
+ ],
+ "groundingToolCount": [ # Grounding tool count.
+ { # The number of grounding tool counts.
+ "count": 42, # The number of grounding tool counts.
+ "type": "A String", # The grounding tool type associated with the count.
+ },
+ ],
+ "inputTokensByModality": [ # A breakdown of input token usage by modality.
+ { # The token count for a single response modality.
+ "modality": "A String", # The modality associated with the token count.
+ "tokens": 42, # Number of tokens for the modality.
+ },
+ ],
+ "outputTokensByModality": [ # A breakdown of output token usage by modality.
+ { # The token count for a single response modality.
+ "modality": "A String", # The modality associated with the token count.
+ "tokens": 42, # Number of tokens for the modality.
+ },
+ ],
+ "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality.
+ { # The token count for a single response modality.
+ "modality": "A String", # The modality associated with the token count.
+ "tokens": 42, # Number of tokens for the modality.
+ },
+ ],
+ "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content).
+ "totalInputTokens": 42, # Number of tokens in the prompt (context).
+ "totalOutputTokens": 42, # Total number of tokens across all the generated responses.
+ "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models.
+ "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens).
+ "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s).
+ },
+ },
+ "stepDelta": { # The step delta data, used for step.delta events. 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",
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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",
+ ],
+ },
+ },
+ "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.
+ },
+ ],
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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.
+ },
+ },
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ ],
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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.
+ },
+ },
+ },
+ "stepStop": { # The step stop data, used for step.stop events. Step-based streaming event, used when steps are enabled.
+ "index": 42,
+ "stepUsage": { # Statistics on the interaction request's token usage. # Model usage stats for this specific step.
+ "cachedTokensByModality": [ # A breakdown of cached token usage by modality.
+ { # 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).
+ },
+ "usage": { # Statistics on the interaction request's token usage. # Cumulative model usage stats from the start of the session.
+ "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).
+ },
+ },
+}
+Returns the indexes Resource.
+
+ interactions()
+
Returns the interactions Resource.
+ + +Returns the interactionsHttp Resource.
+ @@ -971,7 +981,7 @@
+ close()
Close httplib2 connections.
+
+ create(projectsId, locationsId, body=None, x__xgafv=None)
Creates an interaction.
+
+ createStream(projectsId, locationsId, body=None, x__xgafv=None)
Creates an interaction and streams the response.
+ +Deletes an interaction.
+close()
+ Close httplib2 connections.+
create(projectsId, locationsId, body=None, x__xgafv=None)
+ Creates an interaction.
+
+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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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. 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",
+ },
+ "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.
+ "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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ ],
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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.
+ },
+ },
+ ],
+ },
+ "steps": [ # Required. Output only. The steps that make up the interaction, when included in the response.
+ { # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ ],
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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. 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",
+ },
+ "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.
+ "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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ ],
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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.
+ },
+ },
+ ],
+ },
+ "steps": [ # Required. Output only. The steps that make up the interaction, when included in the response.
+ { # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ ],
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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. 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",
+ },
+ "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.
+ "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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ ],
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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.
+ },
+ },
+ ],
+ },
+ "steps": [ # Required. Output only. The steps that make up the interaction, when included in the response.
+ { # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ ],
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ },
+ "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": { # Signals that the Interaction completed. Sent when the Interaction receives Complete/Cancel or naturally terminates. No more input can be sent to the Interaction after this. # The interaction data, used for interaction.completed events. Used when steps are enabled.
+ "interaction": { # Response for InteractionService.CreateInteraction. # Required. Partial completed interaction resource emitted at the end of the stream.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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. 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",
+ },
+ "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.
+ "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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ ],
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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.
+ },
+ },
+ ],
+ },
+ "steps": [ # Required. Output only. The steps that make up the interaction, when included in the response.
+ { # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ ],
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ },
+ "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": { # Server response confirming that a new interaction was created. # The interaction data, used for interaction.created events. Used when steps are enabled.
+ "interaction": { # Response for InteractionService.CreateInteraction. # Required. Partial interaction resource emitted when the stream is created.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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. 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",
+ },
+ "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.
+ "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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ ],
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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.
+ },
+ },
+ ],
+ },
+ "steps": [ # Required. Output only. The steps that make up the interaction, when included in the response.
+ { # 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ ],
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ },
+ "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",
+ "usage": { # Statistics on the interaction request's token usage. # Model usage statistics up to this checkpoint.
+ "cachedTokensByModality": [ # A breakdown of cached token usage by modality.
+ { # The token count for a single response modality.
+ "modality": "A String", # The modality associated with the token count.
+ "tokens": 42, # Number of tokens for the modality.
+ },
+ ],
+ "groundingToolCount": [ # Grounding tool count.
+ { # The number of grounding tool counts.
+ "count": 42, # The number of grounding tool counts.
+ "type": "A String", # The grounding tool type associated with the count.
+ },
+ ],
+ "inputTokensByModality": [ # A breakdown of input token usage by modality.
+ { # The token count for a single response modality.
+ "modality": "A String", # The modality associated with the token count.
+ "tokens": 42, # Number of tokens for the modality.
+ },
+ ],
+ "outputTokensByModality": [ # A breakdown of output token usage by modality.
+ { # The token count for a single response modality.
+ "modality": "A String", # The modality associated with the token count.
+ "tokens": 42, # Number of tokens for the modality.
+ },
+ ],
+ "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality.
+ { # The token count for a single response modality.
+ "modality": "A String", # The modality associated with the token count.
+ "tokens": 42, # Number of tokens for the modality.
+ },
+ ],
+ "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content).
+ "totalInputTokens": 42, # Number of tokens in the prompt (context).
+ "totalOutputTokens": 42, # Total number of tokens across all the generated responses.
+ "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models.
+ "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens).
+ "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s).
+ },
+ },
+ "stepDelta": { # The step delta data, used for step.delta events. 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",
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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",
+ ],
+ },
+ },
+ "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.
+ },
+ ],
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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.
+ },
+ },
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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: GenaiVertexV1Value
+ ],
+ },
+ "nullValue": "A String", # Represents a null value.
+ "numberValue": 3.14, # Represents a double value.
+ "stringValue": "A String", # Represents a string value.
+ "structValue": # Object with schema name: GenaiVertexV1Struct # 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.
+ },
+ ],
+ },
+ "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": { # User provided metadata about the retrieved context.
+ "a_key": "", # Properties of the object.
+ },
+ "documentUri": "A String", # The URI of the file.
+ "fileName": "A String", # The name of the file.
+ "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+ "pageNumber": 42, # Page number of the cited document, if applicable.
+ "source": "A String", # Source attributed for a portion of the text.
+ },
+ "placeCitation": { # A place citation annotation. # A place citation annotation.
+ "name": "A String", # Title of the place.
+ "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+ "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+ "reviewId": "A String", # The ID of the review snippet.
+ "title": "A String", # Title of the review.
+ "url": "A String", # A link that corresponds to the user review on Google Maps.
+ },
+ ],
+ "url": "A String", # URI reference of the place.
+ },
+ "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+ "speaker": "A String", # The speaker to associate with this turn.
+ "style": "A String", # Style instruction for the speech synthesis.
+ },
+ "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+ "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+ "title": "A String", # The title of the URL.
+ "url": "A String", # The URL.
+ },
+ "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+ "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+ "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+ "startOffset": "A String", # Start offset in time of the word relative to 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.
+ },
+ },
+ },
+ "stepStop": { # The step stop data, used for step.stop events. Step-based streaming event, used when steps are enabled.
+ "index": 42,
+ "stepUsage": { # Statistics on the interaction request's token usage. # Model usage stats for this specific step.
+ "cachedTokensByModality": [ # A breakdown of cached token usage by modality.
+ { # 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).
+ },
+ "usage": { # Statistics on the interaction request's token usage. # Cumulative model usage stats from the start of the session.
+ "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).
+ },
+ },
+}
+delete(name, x__xgafv=None)
+ Deletes an interaction.
+
+Args:
+ name: string, Required. The name of the interaction to delete. Format: interactions/{interaction} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for InteractionService.DeleteInteraction.
+}
+Cancels an interaction by id. This only applies to background interactions that are still running.
+
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates a new interaction.
+
+ get(name, lastEventId=None, stream=None, x__xgafv=None)
Retrieves the full details of a single interaction based on its `Interaction.id`.
+cancel(name, x__xgafv=None)
+ Cancels an interaction by id. This only applies to background interactions that are still running.
+
+Args:
+ name: string, Required. The name of the interaction to cancel. Format: `interactions/{interaction}`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+ "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+ "data": "A String", # The HTTP request/response body as raw binary.
+ "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+}
+close()
+ Close httplib2 connections.+
create(parent, body=None, x__xgafv=None)
+ Creates a new interaction.
+
+Args:
+ parent: string, Required. The parent resource where this interaction will be created. Format: `projects/{project}/locations/{location}` Supported only by the Vertex API only. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for [InteractionsService.CreateInteractionHttp].
+ "httpBody": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # Required. The interaction to create.
+ "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+ "data": "A String", # The HTTP request/response body as raw binary.
+ "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+ "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+ "data": "A String", # The HTTP request/response body as raw binary.
+ "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+}
+get(name, lastEventId=None, stream=None, x__xgafv=None)
+ Retrieves the full details of a single interaction based on its `Interaction.id`.
+
+Args:
+ name: string, Required. The name of the interaction to retrieve. Format: interactions/{interaction} (required)
+ lastEventId: string, If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if `stream` is true.
+ stream: boolean, If true, streams the interaction events as Server-Sent Events.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+ "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+ "data": "A String", # The HTTP request/response body as raw binary.
+ "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+}
+Gets information about a location.
getCmekConfig(name, x__xgafv=None)
Gets the CMEK config. Gets the Customer Managed Encryption Key configured with the Cloud Tasks lcoation. By default there is no kms_key configured.
+Gets the CMEK config. Gets the Customer Managed Encryption Key configured with the Cloud Tasks location. By default there is no `kms_key` configured.
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.
@@ -137,10 +137,10 @@getCmekConfig(name, x__xgafv=None)
- Gets the CMEK config. Gets the Customer Managed Encryption Key configured with the Cloud Tasks lcoation. By default there is no kms_key configured.
+ Gets the CMEK config. Gets the Customer Managed Encryption Key configured with the Cloud Tasks location. By default there is no `kms_key` configured.
Args:
- name: string, Required. The config. For example: projects/PROJECT_ID/locations/LOCATION_ID/CmekConfig` (required)
+ name: string, Required. The config. For example: `projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -151,7 +151,7 @@ Method Details
{ # Describes the customer-managed encryption key (CMEK) configuration associated with a project and location.
"kmsKey": "A String", # Resource name of the Cloud KMS key, of the form `projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID`, that will be used to encrypt the Queues & Tasks in the region. Setting this as blank will turn off CMEK encryption.
- "name": "A String", # Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`
+ "name": "A String", # Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format `projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`
}
Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key associated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.
Args:
- name: string, Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig` (required)
+ name: string, Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format `projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig` (required)
body: object, The request body.
The object takes the form of:
{ # Describes the customer-managed encryption key (CMEK) configuration associated with a project and location.
"kmsKey": "A String", # Resource name of the Cloud KMS key, of the form `projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID`, that will be used to encrypt the Queues & Tasks in the region. Setting this as blank will turn off CMEK encryption.
- "name": "A String", # Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`
+ "name": "A String", # Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format `projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`
}
updateMask: string, List of fields to be updated in this request.
@@ -230,7 +230,7 @@ Method Details
{ # Describes the customer-managed encryption key (CMEK) configuration associated with a project and location.
"kmsKey": "A String", # Resource name of the Cloud KMS key, of the form `projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID`, that will be used to encrypt the Queues & Tasks in the region. Setting this as blank will turn off CMEK encryption.
- "name": "A String", # Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`
+ "name": "A String", # Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format `projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`
}
diff --git a/docs/dyn/cloudtasks_v2.projects.locations.queues.html b/docs/dyn/cloudtasks_v2.projects.locations.queues.html
index b57ad9a140..20157e3c83 100644
--- a/docs/dyn/cloudtasks_v2.projects.locations.queues.html
+++ b/docs/dyn/cloudtasks_v2.projects.locations.queues.html
@@ -141,7 +141,7 @@ Returns the assessmentRules Resource.
- -Returns the assistantSessions Resource.
- @@ -375,6 +370,7 @@
fetchGitAheadBehind(name, remoteBranch=None, x__xgafv=None)
Fetches Git ahead/behind against a remote branch.
+
+ fetchHistory(name, pageSize=None, pageToken=None, x__xgafv=None)
Fetches a Workspace's history of commits.
+
+ fetchHistory_next(previous_request, previous_response)
Retrieves the next page of results.
Fetches a single Workspace.
@@ -477,6 +483,53 @@fetchHistory(name, pageSize=None, pageToken=None, x__xgafv=None)
+ Fetches a Workspace's history of commits.
+
+Args:
+ name: string, Required. The workspace's name. (required)
+ pageSize: integer, Optional. Maximum number of commits to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+ pageToken: string, Optional. Page token received from a previous `FetchWorkspaceHistory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchWorkspaceHistory`, with the exception of `page_size`, 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:
+
+ { # `FetchWorkspaceHistory` response message.
+ "commits": [ # A list of commit logs, ordered by 'git log' default order.
+ { # Represents a single commit log.
+ "author": { # Represents the author of a Git commit. # The commit author for this commit log entry.
+ "emailAddress": "A String", # Required. The commit author's email address.
+ "name": "A String", # Required. The commit author's name.
+ },
+ "commitMessage": "A String", # The commit message for this commit log entry.
+ "commitSha": "A String", # The commit SHA for this commit log entry.
+ "commitTime": "A String", # Commit timestamp.
+ },
+ ],
+ "nextPageToken": "A String", # Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ "reachesShallowBoundary": True or False, # Whether this response reaches the shallow boundary of the repository.
+}
+fetchHistory_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)
Fetches a single Workspace. diff --git a/docs/dyn/dataform_v1beta1.projects.locations.teamFolders.html b/docs/dyn/dataform_v1beta1.projects.locations.teamFolders.html index 8ff82df609..ebe5f1481e 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.teamFolders.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.teamFolders.html @@ -358,6 +358,7 @@Method Details
}, }, "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. + "accountConnector": "A String", # Optional. Resource name for the Account Connector used for personal authentication. Must be in the format `projects/*/locations/*/accountConnectors/*` "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. "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`. diff --git a/docs/dyn/datalineage_v1.projects.locations.html b/docs/dyn/datalineage_v1.projects.locations.html index 0043f77676..fddfe9b17d 100644 --- a/docs/dyn/datalineage_v1.projects.locations.html +++ b/docs/dyn/datalineage_v1.projects.locations.html @@ -213,6 +213,9 @@Method Details
"A String", ], "entitySet": "A String", # Optional. Entity set restriction. If unspecified, the method returns all entities. + "projects": [ # Optional. Projects to restrict lineage links to. Callers can provide project IDs (for example, `projects/my-project`) or project numbers (for example, `projects/123456789`). If unspecified, lineage is returned from all projects. + "A String", + ], "timeRange": { # 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. Time interval to search for lineage. If unspecified, all lineage is returned. Currently, at most one of `start_time` and `end_time` can be set. "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. diff --git a/docs/dyn/dataplex_v1.projects.locations.aspectTypes.html b/docs/dyn/dataplex_v1.projects.locations.aspectTypes.html index 4b8853b825..cbad55a96e 100644 --- a/docs/dyn/dataplex_v1.projects.locations.aspectTypes.html +++ b/docs/dyn/dataplex_v1.projects.locations.aspectTypes.html @@ -137,7 +137,7 @@Method Details
"description": "A String", # Optional. Description for a field. "displayName": "A String", # Optional. Display name for a field. "displayOrder": 42, # Optional. Display order for a field. You can use this to reorder where a field is rendered. - "stringType": "A String", # Optional. You can use String Type annotations to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified URL link. resource: A service qualified resource reference. + "stringType": "A String", # Optional. You can use String Type annotations to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. markdown: The field must be interpreted as a markdown field. url: A fully qualified URL link. resource: A service qualified resource reference. "stringValues": [ # Optional. Suggested hints for string fields. You can use them to suggest values to users through console. "A String", ], @@ -268,7 +268,7 @@Method Details
"description": "A String", # Optional. Description for a field. "displayName": "A String", # Optional. Display name for a field. "displayOrder": 42, # Optional. Display order for a field. You can use this to reorder where a field is rendered. - "stringType": "A String", # Optional. You can use String Type annotations to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified URL link. resource: A service qualified resource reference. + "stringType": "A String", # Optional. You can use String Type annotations to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. markdown: The field must be interpreted as a markdown field. url: A fully qualified URL link. resource: A service qualified resource reference. "stringValues": [ # Optional. Suggested hints for string fields. You can use them to suggest values to users through console. "A String", ], @@ -387,7 +387,7 @@Method Details
"description": "A String", # Optional. Description for a field. "displayName": "A String", # Optional. Display name for a field. "displayOrder": 42, # Optional. Display order for a field. You can use this to reorder where a field is rendered. - "stringType": "A String", # Optional. You can use String Type annotations to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified URL link. resource: A service qualified resource reference. + "stringType": "A String", # Optional. You can use String Type annotations to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. markdown: The field must be interpreted as a markdown field. url: A fully qualified URL link. resource: A service qualified resource reference. "stringValues": [ # Optional. Suggested hints for string fields. You can use them to suggest values to users through console. "A String", ], @@ -467,7 +467,7 @@Method Details
"description": "A String", # Optional. Description for a field. "displayName": "A String", # Optional. Display name for a field. "displayOrder": 42, # Optional. Display order for a field. You can use this to reorder where a field is rendered. - "stringType": "A String", # Optional. You can use String Type annotations to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified URL link. resource: A service qualified resource reference. + "stringType": "A String", # Optional. You can use String Type annotations to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. markdown: The field must be interpreted as a markdown field. url: A fully qualified URL link. resource: A service qualified resource reference. "stringValues": [ # Optional. Suggested hints for string fields. You can use them to suggest values to users through console. "A String", ], diff --git a/docs/dyn/dataplex_v1.projects.locations.changeRequests.html b/docs/dyn/dataplex_v1.projects.locations.changeRequests.html index ccaf7da4ba..82b5991963 100644 --- a/docs/dyn/dataplex_v1.projects.locations.changeRequests.html +++ b/docs/dyn/dataplex_v1.projects.locations.changeRequests.html @@ -133,6 +133,205 @@Method Details
{ # Represents a proposed change to a metadata resource. "approver": "A String", # Output only. The email address of the user who approved/rejected the ChangeRequest. "author": "A String", # Output only. The email address of the user who created the ChangeRequest. + "batchChangeMetadataRequest": { # Request message for batch changing metadata. Requires permission to perform the underlying change, depending on the type and content of the change. Per operation, required permissions are: - for CreateEntry: dataplex.entries.create - for UpdateEntry: dataplex.entries.update - for DeleteEntry: dataplex.entries.delete - for CreateEntryLink: dataplex.entryLinks.create - for UpdateEntryLink: dataplex.entryLinks.update - for DeleteEntryLink: dataplex.entryLinks.deleteAnd per used type permissions are: - for EntryType: dataplex.entryTypes.use or dataplex.entryGroups.useEntry for reusable built-in types, - for AspectType: dataplex.aspectTypes.use or dataplex.entryGroups.useAspect for reusable built-in types and - for EntryLinkType: dataplex.entryLinkTypes.use or dataplex.entryGroups.useEntryLink for reusable built-in types. # Payload for executing a batch of catalog changes. + "changes": [ # Required. The list of changes to apply. Only a single change per resource is supported. Maximum number of changes supported is 250. + { # Detailed description of an individual change. + "createEntryLinkRequest": { # Request message for CreateEntryLink. # Payload for creating an EntryLink. + "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource. + "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry Link was created. + "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition + "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. + { # Reference to the Entry that is linked through the Entry Link. + "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. + "type": "A String", # Required. Immutable. The reference type of the Entry. + }, + ], + "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "updateTime": "A String", # Output only. The time when the Entry Link was last updated. + }, + "entryLinkId": "A String", # Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup. + "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. + }, + "createEntryRequest": { # Create Entry request. # Payload for creating an Entry. + "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. + }, + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog. + }, + "entryId": "A String", # Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters. + "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}. + }, + "deleteEntryLinkRequest": { # Request message for DeleteEntryLink. # Payload for deleting an EntryLink. + "name": "A String", # Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}. + }, + "deleteEntryRequest": { # Delete Entry request. # Payload for deleting an Entry. + "name": "A String", # Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + }, + "updateEntryLinkRequest": { # Request message for UpdateEntryLink method. # Payload for updating an EntryLink. + "allowMissing": True or False, # Optional. If set to true and the entry link doesn't exist, the service will create it. + "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It should be the aspect type reference in the format {project_id_or_number}.{location_id}.{aspect_type_id}.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. + "A String", + ], + "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource. + "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry Link was created. + "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition + "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. + { # Reference to the Entry that is linked through the Entry Link. + "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. + "type": "A String", # Required. Immutable. The reference type of the Entry. + }, + ], + "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "updateTime": "A String", # Output only. The time when the Entry Link was last updated. + }, + }, + "updateEntryRequest": { # Update Entry request. # Payload for updating an Entry. + "allowMissing": True or False, # Optional. If set to true and the entry doesn't exist, the service will create it. + "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. + "A String", + ], + "deleteMissingAspects": True or False, # Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request. + "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. + }, + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog. + }, + "updateMask": "A String", # Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request. + }, + }, + ], + "description": { # Description of the batch change. # Optional. Text description of the batch change. + "content": "A String", # Optional. The text description content. + "job": { # Description of the job that created the batch change. # Optional. The job that created the batch change. + "name": "A String", # Optional. The name of the job that created the batch change. For example: projects/{project_number}/locations/{location_id}/enrichmentTasks/{enrichment_task_id}/runs/{enrichment_run_id} + "runTime": "A String", # Optional. The start time of the job run that created the batch change. + }, + }, + "name": "A String", # Required. The resource name of the EntryGroup on which the batch change applies. Format: projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id} + }, + "batchChangeMetadataResponse": { # Response message for BatchChangeMetadata. # Output only. Result of applying a batch change metadata request. + "failedRequests": { # A map of failed requests for a batch change, where the key is the 0-based index of the failed request in the batch and the value is the error status. If all operations succeeded, this map is empty. + "a_key": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + }, + }, "changeType": "A String", # Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof. "createEntry": { # Create Entry request. # Payload for creating an Entry. "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource. @@ -443,6 +642,205 @@Method Details
{ # Represents a proposed change to a metadata resource. "approver": "A String", # Output only. The email address of the user who approved/rejected the ChangeRequest. "author": "A String", # Output only. The email address of the user who created the ChangeRequest. + "batchChangeMetadataRequest": { # Request message for batch changing metadata. Requires permission to perform the underlying change, depending on the type and content of the change. Per operation, required permissions are: - for CreateEntry: dataplex.entries.create - for UpdateEntry: dataplex.entries.update - for DeleteEntry: dataplex.entries.delete - for CreateEntryLink: dataplex.entryLinks.create - for UpdateEntryLink: dataplex.entryLinks.update - for DeleteEntryLink: dataplex.entryLinks.deleteAnd per used type permissions are: - for EntryType: dataplex.entryTypes.use or dataplex.entryGroups.useEntry for reusable built-in types, - for AspectType: dataplex.aspectTypes.use or dataplex.entryGroups.useAspect for reusable built-in types and - for EntryLinkType: dataplex.entryLinkTypes.use or dataplex.entryGroups.useEntryLink for reusable built-in types. # Payload for executing a batch of catalog changes. + "changes": [ # Required. The list of changes to apply. Only a single change per resource is supported. Maximum number of changes supported is 250. + { # Detailed description of an individual change. + "createEntryLinkRequest": { # Request message for CreateEntryLink. # Payload for creating an EntryLink. + "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource. + "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry Link was created. + "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition + "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. + { # Reference to the Entry that is linked through the Entry Link. + "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. + "type": "A String", # Required. Immutable. The reference type of the Entry. + }, + ], + "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "updateTime": "A String", # Output only. The time when the Entry Link was last updated. + }, + "entryLinkId": "A String", # Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup. + "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. + }, + "createEntryRequest": { # Create Entry request. # Payload for creating an Entry. + "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. + }, + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog. + }, + "entryId": "A String", # Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters. + "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}. + }, + "deleteEntryLinkRequest": { # Request message for DeleteEntryLink. # Payload for deleting an EntryLink. + "name": "A String", # Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}. + }, + "deleteEntryRequest": { # Delete Entry request. # Payload for deleting an Entry. + "name": "A String", # Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + }, + "updateEntryLinkRequest": { # Request message for UpdateEntryLink method. # Payload for updating an EntryLink. + "allowMissing": True or False, # Optional. If set to true and the entry link doesn't exist, the service will create it. + "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It should be the aspect type reference in the format {project_id_or_number}.{location_id}.{aspect_type_id}.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. + "A String", + ], + "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource. + "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry Link was created. + "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition + "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. + { # Reference to the Entry that is linked through the Entry Link. + "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. + "type": "A String", # Required. Immutable. The reference type of the Entry. + }, + ], + "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "updateTime": "A String", # Output only. The time when the Entry Link was last updated. + }, + }, + "updateEntryRequest": { # Update Entry request. # Payload for updating an Entry. + "allowMissing": True or False, # Optional. If set to true and the entry doesn't exist, the service will create it. + "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. + "A String", + ], + "deleteMissingAspects": True or False, # Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request. + "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. + }, + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog. + }, + "updateMask": "A String", # Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request. + }, + }, + ], + "description": { # Description of the batch change. # Optional. Text description of the batch change. + "content": "A String", # Optional. The text description content. + "job": { # Description of the job that created the batch change. # Optional. The job that created the batch change. + "name": "A String", # Optional. The name of the job that created the batch change. For example: projects/{project_number}/locations/{location_id}/enrichmentTasks/{enrichment_task_id}/runs/{enrichment_run_id} + "runTime": "A String", # Optional. The start time of the job run that created the batch change. + }, + }, + "name": "A String", # Required. The resource name of the EntryGroup on which the batch change applies. Format: projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id} + }, + "batchChangeMetadataResponse": { # Response message for BatchChangeMetadata. # Output only. Result of applying a batch change metadata request. + "failedRequests": { # A map of failed requests for a batch change, where the key is the 0-based index of the failed request in the batch and the value is the error status. If all operations succeeded, this map is empty. + "a_key": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + }, + }, "changeType": "A String", # Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof. "createEntry": { # Create Entry request. # Payload for creating an Entry. "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource. @@ -783,6 +1181,205 @@Method Details
{ # Represents a proposed change to a metadata resource. "approver": "A String", # Output only. The email address of the user who approved/rejected the ChangeRequest. "author": "A String", # Output only. The email address of the user who created the ChangeRequest. + "batchChangeMetadataRequest": { # Request message for batch changing metadata. Requires permission to perform the underlying change, depending on the type and content of the change. Per operation, required permissions are: - for CreateEntry: dataplex.entries.create - for UpdateEntry: dataplex.entries.update - for DeleteEntry: dataplex.entries.delete - for CreateEntryLink: dataplex.entryLinks.create - for UpdateEntryLink: dataplex.entryLinks.update - for DeleteEntryLink: dataplex.entryLinks.deleteAnd per used type permissions are: - for EntryType: dataplex.entryTypes.use or dataplex.entryGroups.useEntry for reusable built-in types, - for AspectType: dataplex.aspectTypes.use or dataplex.entryGroups.useAspect for reusable built-in types and - for EntryLinkType: dataplex.entryLinkTypes.use or dataplex.entryGroups.useEntryLink for reusable built-in types. # Payload for executing a batch of catalog changes. + "changes": [ # Required. The list of changes to apply. Only a single change per resource is supported. Maximum number of changes supported is 250. + { # Detailed description of an individual change. + "createEntryLinkRequest": { # Request message for CreateEntryLink. # Payload for creating an EntryLink. + "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource. + "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry Link was created. + "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition + "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. + { # Reference to the Entry that is linked through the Entry Link. + "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. + "type": "A String", # Required. Immutable. The reference type of the Entry. + }, + ], + "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "updateTime": "A String", # Output only. The time when the Entry Link was last updated. + }, + "entryLinkId": "A String", # Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup. + "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. + }, + "createEntryRequest": { # Create Entry request. # Payload for creating an Entry. + "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. + }, + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog. + }, + "entryId": "A String", # Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters. + "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}. + }, + "deleteEntryLinkRequest": { # Request message for DeleteEntryLink. # Payload for deleting an EntryLink. + "name": "A String", # Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}. + }, + "deleteEntryRequest": { # Delete Entry request. # Payload for deleting an Entry. + "name": "A String", # Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + }, + "updateEntryLinkRequest": { # Request message for UpdateEntryLink method. # Payload for updating an EntryLink. + "allowMissing": True or False, # Optional. If set to true and the entry link doesn't exist, the service will create it. + "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It should be the aspect type reference in the format {project_id_or_number}.{location_id}.{aspect_type_id}.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. + "A String", + ], + "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource. + "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry Link was created. + "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition + "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. + { # Reference to the Entry that is linked through the Entry Link. + "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. + "type": "A String", # Required. Immutable. The reference type of the Entry. + }, + ], + "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "updateTime": "A String", # Output only. The time when the Entry Link was last updated. + }, + }, + "updateEntryRequest": { # Update Entry request. # Payload for updating an Entry. + "allowMissing": True or False, # Optional. If set to true and the entry doesn't exist, the service will create it. + "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. + "A String", + ], + "deleteMissingAspects": True or False, # Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request. + "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. + }, + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog. + }, + "updateMask": "A String", # Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request. + }, + }, + ], + "description": { # Description of the batch change. # Optional. Text description of the batch change. + "content": "A String", # Optional. The text description content. + "job": { # Description of the job that created the batch change. # Optional. The job that created the batch change. + "name": "A String", # Optional. The name of the job that created the batch change. For example: projects/{project_number}/locations/{location_id}/enrichmentTasks/{enrichment_task_id}/runs/{enrichment_run_id} + "runTime": "A String", # Optional. The start time of the job run that created the batch change. + }, + }, + "name": "A String", # Required. The resource name of the EntryGroup on which the batch change applies. Format: projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id} + }, + "batchChangeMetadataResponse": { # Response message for BatchChangeMetadata. # Output only. Result of applying a batch change metadata request. + "failedRequests": { # A map of failed requests for a batch change, where the key is the 0-based index of the failed request in the batch and the value is the error status. If all operations succeeded, this map is empty. + "a_key": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + }, + }, "changeType": "A String", # Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof. "createEntry": { # Create Entry request. # Payload for creating an Entry. "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource. @@ -1084,6 +1681,205 @@Method Details
{ # Represents a proposed change to a metadata resource. "approver": "A String", # Output only. The email address of the user who approved/rejected the ChangeRequest. "author": "A String", # Output only. The email address of the user who created the ChangeRequest. + "batchChangeMetadataRequest": { # Request message for batch changing metadata. Requires permission to perform the underlying change, depending on the type and content of the change. Per operation, required permissions are: - for CreateEntry: dataplex.entries.create - for UpdateEntry: dataplex.entries.update - for DeleteEntry: dataplex.entries.delete - for CreateEntryLink: dataplex.entryLinks.create - for UpdateEntryLink: dataplex.entryLinks.update - for DeleteEntryLink: dataplex.entryLinks.deleteAnd per used type permissions are: - for EntryType: dataplex.entryTypes.use or dataplex.entryGroups.useEntry for reusable built-in types, - for AspectType: dataplex.aspectTypes.use or dataplex.entryGroups.useAspect for reusable built-in types and - for EntryLinkType: dataplex.entryLinkTypes.use or dataplex.entryGroups.useEntryLink for reusable built-in types. # Payload for executing a batch of catalog changes. + "changes": [ # Required. The list of changes to apply. Only a single change per resource is supported. Maximum number of changes supported is 250. + { # Detailed description of an individual change. + "createEntryLinkRequest": { # Request message for CreateEntryLink. # Payload for creating an EntryLink. + "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource. + "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry Link was created. + "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition + "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. + { # Reference to the Entry that is linked through the Entry Link. + "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. + "type": "A String", # Required. Immutable. The reference type of the Entry. + }, + ], + "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "updateTime": "A String", # Output only. The time when the Entry Link was last updated. + }, + "entryLinkId": "A String", # Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup. + "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. + }, + "createEntryRequest": { # Create Entry request. # Payload for creating an Entry. + "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. + }, + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog. + }, + "entryId": "A String", # Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters. + "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}. + }, + "deleteEntryLinkRequest": { # Request message for DeleteEntryLink. # Payload for deleting an EntryLink. + "name": "A String", # Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}. + }, + "deleteEntryRequest": { # Delete Entry request. # Payload for deleting an Entry. + "name": "A String", # Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + }, + "updateEntryLinkRequest": { # Request message for UpdateEntryLink method. # Payload for updating an EntryLink. + "allowMissing": True or False, # Optional. If set to true and the entry link doesn't exist, the service will create it. + "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It should be the aspect type reference in the format {project_id_or_number}.{location_id}.{aspect_type_id}.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. + "A String", + ], + "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource. + "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry Link was created. + "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition + "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. + { # Reference to the Entry that is linked through the Entry Link. + "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. + "type": "A String", # Required. Immutable. The reference type of the Entry. + }, + ], + "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "updateTime": "A String", # Output only. The time when the Entry Link was last updated. + }, + }, + "updateEntryRequest": { # Update Entry request. # Payload for updating an Entry. + "allowMissing": True or False, # Optional. If set to true and the entry doesn't exist, the service will create it. + "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. + "A String", + ], + "deleteMissingAspects": True or False, # Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request. + "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. + }, + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog. + }, + "updateMask": "A String", # Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request. + }, + }, + ], + "description": { # Description of the batch change. # Optional. Text description of the batch change. + "content": "A String", # Optional. The text description content. + "job": { # Description of the job that created the batch change. # Optional. The job that created the batch change. + "name": "A String", # Optional. The name of the job that created the batch change. For example: projects/{project_number}/locations/{location_id}/enrichmentTasks/{enrichment_task_id}/runs/{enrichment_run_id} + "runTime": "A String", # Optional. The start time of the job run that created the batch change. + }, + }, + "name": "A String", # Required. The resource name of the EntryGroup on which the batch change applies. Format: projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id} + }, + "batchChangeMetadataResponse": { # Response message for BatchChangeMetadata. # Output only. Result of applying a batch change metadata request. + "failedRequests": { # A map of failed requests for a batch change, where the key is the 0-based index of the failed request in the batch and the value is the error status. If all operations succeeded, this map is empty. + "a_key": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + }, + }, "changeType": "A String", # Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof. "createEntry": { # Create Entry request. # Payload for creating an Entry. "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource. @@ -1364,6 +2160,205 @@Method Details
{ # Represents a proposed change to a metadata resource. "approver": "A String", # Output only. The email address of the user who approved/rejected the ChangeRequest. "author": "A String", # Output only. The email address of the user who created the ChangeRequest. + "batchChangeMetadataRequest": { # Request message for batch changing metadata. Requires permission to perform the underlying change, depending on the type and content of the change. Per operation, required permissions are: - for CreateEntry: dataplex.entries.create - for UpdateEntry: dataplex.entries.update - for DeleteEntry: dataplex.entries.delete - for CreateEntryLink: dataplex.entryLinks.create - for UpdateEntryLink: dataplex.entryLinks.update - for DeleteEntryLink: dataplex.entryLinks.deleteAnd per used type permissions are: - for EntryType: dataplex.entryTypes.use or dataplex.entryGroups.useEntry for reusable built-in types, - for AspectType: dataplex.aspectTypes.use or dataplex.entryGroups.useAspect for reusable built-in types and - for EntryLinkType: dataplex.entryLinkTypes.use or dataplex.entryGroups.useEntryLink for reusable built-in types. # Payload for executing a batch of catalog changes. + "changes": [ # Required. The list of changes to apply. Only a single change per resource is supported. Maximum number of changes supported is 250. + { # Detailed description of an individual change. + "createEntryLinkRequest": { # Request message for CreateEntryLink. # Payload for creating an EntryLink. + "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource. + "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry Link was created. + "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition + "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. + { # Reference to the Entry that is linked through the Entry Link. + "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. + "type": "A String", # Required. Immutable. The reference type of the Entry. + }, + ], + "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "updateTime": "A String", # Output only. The time when the Entry Link was last updated. + }, + "entryLinkId": "A String", # Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup. + "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. + }, + "createEntryRequest": { # Create Entry request. # Payload for creating an Entry. + "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. + }, + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog. + }, + "entryId": "A String", # Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters. + "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}. + }, + "deleteEntryLinkRequest": { # Request message for DeleteEntryLink. # Payload for deleting an EntryLink. + "name": "A String", # Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}. + }, + "deleteEntryRequest": { # Delete Entry request. # Payload for deleting an Entry. + "name": "A String", # Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + }, + "updateEntryLinkRequest": { # Request message for UpdateEntryLink method. # Payload for updating an EntryLink. + "allowMissing": True or False, # Optional. If set to true and the entry link doesn't exist, the service will create it. + "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It should be the aspect type reference in the format {project_id_or_number}.{location_id}.{aspect_type_id}.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. + "A String", + ], + "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource. + "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry Link was created. + "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition + "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. + { # Reference to the Entry that is linked through the Entry Link. + "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. + "type": "A String", # Required. Immutable. The reference type of the Entry. + }, + ], + "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "updateTime": "A String", # Output only. The time when the Entry Link was last updated. + }, + }, + "updateEntryRequest": { # Update Entry request. # Payload for updating an Entry. + "allowMissing": True or False, # Optional. If set to true and the entry doesn't exist, the service will create it. + "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. + "A String", + ], + "deleteMissingAspects": True or False, # Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request. + "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. + }, + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog. + }, + "updateMask": "A String", # Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request. + }, + }, + ], + "description": { # Description of the batch change. # Optional. Text description of the batch change. + "content": "A String", # Optional. The text description content. + "job": { # Description of the job that created the batch change. # Optional. The job that created the batch change. + "name": "A String", # Optional. The name of the job that created the batch change. For example: projects/{project_number}/locations/{location_id}/enrichmentTasks/{enrichment_task_id}/runs/{enrichment_run_id} + "runTime": "A String", # Optional. The start time of the job run that created the batch change. + }, + }, + "name": "A String", # Required. The resource name of the EntryGroup on which the batch change applies. Format: projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id} + }, + "batchChangeMetadataResponse": { # Response message for BatchChangeMetadata. # Output only. Result of applying a batch change metadata request. + "failedRequests": { # A map of failed requests for a batch change, where the key is the 0-based index of the failed request in the batch and the value is the error status. If all operations succeeded, this map is empty. + "a_key": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + }, + }, "changeType": "A String", # Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof. "createEntry": { # Create Entry request. # Payload for creating an Entry. "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource. @@ -1658,6 +2653,205 @@Method Details
{ # Represents a proposed change to a metadata resource. "approver": "A String", # Output only. The email address of the user who approved/rejected the ChangeRequest. "author": "A String", # Output only. The email address of the user who created the ChangeRequest. + "batchChangeMetadataRequest": { # Request message for batch changing metadata. Requires permission to perform the underlying change, depending on the type and content of the change. Per operation, required permissions are: - for CreateEntry: dataplex.entries.create - for UpdateEntry: dataplex.entries.update - for DeleteEntry: dataplex.entries.delete - for CreateEntryLink: dataplex.entryLinks.create - for UpdateEntryLink: dataplex.entryLinks.update - for DeleteEntryLink: dataplex.entryLinks.deleteAnd per used type permissions are: - for EntryType: dataplex.entryTypes.use or dataplex.entryGroups.useEntry for reusable built-in types, - for AspectType: dataplex.aspectTypes.use or dataplex.entryGroups.useAspect for reusable built-in types and - for EntryLinkType: dataplex.entryLinkTypes.use or dataplex.entryGroups.useEntryLink for reusable built-in types. # Payload for executing a batch of catalog changes. + "changes": [ # Required. The list of changes to apply. Only a single change per resource is supported. Maximum number of changes supported is 250. + { # Detailed description of an individual change. + "createEntryLinkRequest": { # Request message for CreateEntryLink. # Payload for creating an EntryLink. + "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource. + "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry Link was created. + "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition + "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. + { # Reference to the Entry that is linked through the Entry Link. + "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. + "type": "A String", # Required. Immutable. The reference type of the Entry. + }, + ], + "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "updateTime": "A String", # Output only. The time when the Entry Link was last updated. + }, + "entryLinkId": "A String", # Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup. + "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. + }, + "createEntryRequest": { # Create Entry request. # Payload for creating an Entry. + "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. + }, + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog. + }, + "entryId": "A String", # Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters. + "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}. + }, + "deleteEntryLinkRequest": { # Request message for DeleteEntryLink. # Payload for deleting an EntryLink. + "name": "A String", # Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}. + }, + "deleteEntryRequest": { # Delete Entry request. # Payload for deleting an Entry. + "name": "A String", # Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + }, + "updateEntryLinkRequest": { # Request message for UpdateEntryLink method. # Payload for updating an EntryLink. + "allowMissing": True or False, # Optional. If set to true and the entry link doesn't exist, the service will create it. + "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It should be the aspect type reference in the format {project_id_or_number}.{location_id}.{aspect_type_id}.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. + "A String", + ], + "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource. + "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry Link was created. + "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition + "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. + { # Reference to the Entry that is linked through the Entry Link. + "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. + "type": "A String", # Required. Immutable. The reference type of the Entry. + }, + ], + "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "updateTime": "A String", # Output only. The time when the Entry Link was last updated. + }, + }, + "updateEntryRequest": { # Update Entry request. # Payload for updating an Entry. + "allowMissing": True or False, # Optional. If set to true and the entry doesn't exist, the service will create it. + "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. + "A String", + ], + "deleteMissingAspects": True or False, # Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request. + "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. + }, + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog. + }, + "updateMask": "A String", # Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request. + }, + }, + ], + "description": { # Description of the batch change. # Optional. Text description of the batch change. + "content": "A String", # Optional. The text description content. + "job": { # Description of the job that created the batch change. # Optional. The job that created the batch change. + "name": "A String", # Optional. The name of the job that created the batch change. For example: projects/{project_number}/locations/{location_id}/enrichmentTasks/{enrichment_task_id}/runs/{enrichment_run_id} + "runTime": "A String", # Optional. The start time of the job run that created the batch change. + }, + }, + "name": "A String", # Required. The resource name of the EntryGroup on which the batch change applies. Format: projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id} + }, + "batchChangeMetadataResponse": { # Response message for BatchChangeMetadata. # Output only. Result of applying a batch change metadata request. + "failedRequests": { # A map of failed requests for a batch change, where the key is the 0-based index of the failed request in the batch and the value is the error status. If all operations succeeded, this map is empty. + "a_key": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + }, + }, "changeType": "A String", # Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof. "createEntry": { # Create Entry request. # Payload for creating an Entry. "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource. diff --git a/docs/dyn/dataplex_v1.projects.locations.dataProducts.html b/docs/dyn/dataplex_v1.projects.locations.dataProducts.html index 5a16eaa08c..f8bbe09ea1 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataProducts.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataProducts.html @@ -500,6 +500,205 @@Method Details
"changeRequest": { # Represents a proposed change to a metadata resource. # Required. The change request for the data product access request. "approver": "A String", # Output only. The email address of the user who approved/rejected the ChangeRequest. "author": "A String", # Output only. The email address of the user who created the ChangeRequest. + "batchChangeMetadataRequest": { # Request message for batch changing metadata. Requires permission to perform the underlying change, depending on the type and content of the change. Per operation, required permissions are: - for CreateEntry: dataplex.entries.create - for UpdateEntry: dataplex.entries.update - for DeleteEntry: dataplex.entries.delete - for CreateEntryLink: dataplex.entryLinks.create - for UpdateEntryLink: dataplex.entryLinks.update - for DeleteEntryLink: dataplex.entryLinks.deleteAnd per used type permissions are: - for EntryType: dataplex.entryTypes.use or dataplex.entryGroups.useEntry for reusable built-in types, - for AspectType: dataplex.aspectTypes.use or dataplex.entryGroups.useAspect for reusable built-in types and - for EntryLinkType: dataplex.entryLinkTypes.use or dataplex.entryGroups.useEntryLink for reusable built-in types. # Payload for executing a batch of catalog changes. + "changes": [ # Required. The list of changes to apply. Only a single change per resource is supported. Maximum number of changes supported is 250. + { # Detailed description of an individual change. + "createEntryLinkRequest": { # Request message for CreateEntryLink. # Payload for creating an EntryLink. + "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource. + "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry Link was created. + "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition + "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. + { # Reference to the Entry that is linked through the Entry Link. + "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. + "type": "A String", # Required. Immutable. The reference type of the Entry. + }, + ], + "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "updateTime": "A String", # Output only. The time when the Entry Link was last updated. + }, + "entryLinkId": "A String", # Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup. + "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. + }, + "createEntryRequest": { # Create Entry request. # Payload for creating an Entry. + "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. + }, + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog. + }, + "entryId": "A String", # Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters. + "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}. + }, + "deleteEntryLinkRequest": { # Request message for DeleteEntryLink. # Payload for deleting an EntryLink. + "name": "A String", # Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}. + }, + "deleteEntryRequest": { # Delete Entry request. # Payload for deleting an Entry. + "name": "A String", # Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + }, + "updateEntryLinkRequest": { # Request message for UpdateEntryLink method. # Payload for updating an EntryLink. + "allowMissing": True or False, # Optional. If set to true and the entry link doesn't exist, the service will create it. + "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It should be the aspect type reference in the format {project_id_or_number}.{location_id}.{aspect_type_id}.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. + "A String", + ], + "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource. + "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry Link was created. + "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition + "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. + { # Reference to the Entry that is linked through the Entry Link. + "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. + "type": "A String", # Required. Immutable. The reference type of the Entry. + }, + ], + "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "updateTime": "A String", # Output only. The time when the Entry Link was last updated. + }, + }, + "updateEntryRequest": { # Update Entry request. # Payload for updating an Entry. + "allowMissing": True or False, # Optional. If set to true and the entry doesn't exist, the service will create it. + "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. + "A String", + ], + "deleteMissingAspects": True or False, # Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request. + "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. + }, + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog. + }, + "updateMask": "A String", # Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request. + }, + }, + ], + "description": { # Description of the batch change. # Optional. Text description of the batch change. + "content": "A String", # Optional. The text description content. + "job": { # Description of the job that created the batch change. # Optional. The job that created the batch change. + "name": "A String", # Optional. The name of the job that created the batch change. For example: projects/{project_number}/locations/{location_id}/enrichmentTasks/{enrichment_task_id}/runs/{enrichment_run_id} + "runTime": "A String", # Optional. The start time of the job run that created the batch change. + }, + }, + "name": "A String", # Required. The resource name of the EntryGroup on which the batch change applies. Format: projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id} + }, + "batchChangeMetadataResponse": { # Response message for BatchChangeMetadata. # Output only. Result of applying a batch change metadata request. + "failedRequests": { # A map of failed requests for a batch change, where the key is the 0-based index of the failed request in the batch and the value is the error status. If all operations succeeded, this map is empty. + "a_key": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + }, + }, "changeType": "A String", # Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof. "createEntry": { # Create Entry request. # Payload for creating an Entry. "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource. diff --git a/docs/dyn/dataplex_v1.projects.locations.entryGroups.html b/docs/dyn/dataplex_v1.projects.locations.entryGroups.html index ab17317755..4dbadeaa2a 100644 --- a/docs/dyn/dataplex_v1.projects.locations.entryGroups.html +++ b/docs/dyn/dataplex_v1.projects.locations.entryGroups.html @@ -84,6 +84,9 @@Instance Methods
Returns the entryLinks Resource.
++
+batchChangeMetadata(name, body=None, x__xgafv=None)Batch changes metadata within an EntryGroup.
Close httplib2 connections.
@@ -108,6 +111,9 @@Instance Methods
patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None)Updates an EntryGroup.
++
+requestBatchMetadataChange(name, body=None, x__xgafv=None)Submits a catalog change request for multiple resources within an EntryGroup. This method creates a ChangeRequest resource that must be reviewed and approved before the proposed changes are applied.
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.
@@ -115,6 +121,231 @@Instance Methods
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
+++batchChangeMetadata(name, body=None, x__xgafv=None)+Batch changes metadata within an EntryGroup. + +Args: + name: string, Required. The resource name of the EntryGroup on which the batch change applies. Format: projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id} (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for batch changing metadata. Requires permission to perform the underlying change, depending on the type and content of the change. Per operation, required permissions are: - for CreateEntry: dataplex.entries.create - for UpdateEntry: dataplex.entries.update - for DeleteEntry: dataplex.entries.delete - for CreateEntryLink: dataplex.entryLinks.create - for UpdateEntryLink: dataplex.entryLinks.update - for DeleteEntryLink: dataplex.entryLinks.deleteAnd per used type permissions are: - for EntryType: dataplex.entryTypes.use or dataplex.entryGroups.useEntry for reusable built-in types, - for AspectType: dataplex.aspectTypes.use or dataplex.entryGroups.useAspect for reusable built-in types and - for EntryLinkType: dataplex.entryLinkTypes.use or dataplex.entryGroups.useEntryLink for reusable built-in types. + "changes": [ # Required. The list of changes to apply. Only a single change per resource is supported. Maximum number of changes supported is 250. + { # Detailed description of an individual change. + "createEntryLinkRequest": { # Request message for CreateEntryLink. # Payload for creating an EntryLink. + "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource. + "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry Link was created. + "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition + "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. + { # Reference to the Entry that is linked through the Entry Link. + "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. + "type": "A String", # Required. Immutable. The reference type of the Entry. + }, + ], + "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "updateTime": "A String", # Output only. The time when the Entry Link was last updated. + }, + "entryLinkId": "A String", # Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup. + "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. + }, + "createEntryRequest": { # Create Entry request. # Payload for creating an Entry. + "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. + }, + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog. + }, + "entryId": "A String", # Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters. + "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}. + }, + "deleteEntryLinkRequest": { # Request message for DeleteEntryLink. # Payload for deleting an EntryLink. + "name": "A String", # Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}. + }, + "deleteEntryRequest": { # Delete Entry request. # Payload for deleting an Entry. + "name": "A String", # Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + }, + "updateEntryLinkRequest": { # Request message for UpdateEntryLink method. # Payload for updating an EntryLink. + "allowMissing": True or False, # Optional. If set to true and the entry link doesn't exist, the service will create it. + "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It should be the aspect type reference in the format {project_id_or_number}.{location_id}.{aspect_type_id}.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. + "A String", + ], + "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource. + "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry Link was created. + "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition + "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. + { # Reference to the Entry that is linked through the Entry Link. + "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. + "type": "A String", # Required. Immutable. The reference type of the Entry. + }, + ], + "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "updateTime": "A String", # Output only. The time when the Entry Link was last updated. + }, + }, + "updateEntryRequest": { # Update Entry request. # Payload for updating an Entry. + "allowMissing": True or False, # Optional. If set to true and the entry doesn't exist, the service will create it. + "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. + "A String", + ], + "deleteMissingAspects": True or False, # Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request. + "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. + }, + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog. + }, + "updateMask": "A String", # Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request. + }, + }, + ], + "description": { # Description of the batch change. # Optional. Text description of the batch change. + "content": "A String", # Optional. The text description content. + "job": { # Description of the job that created the batch change. # Optional. The job that created the batch change. + "name": "A String", # Optional. The name of the job that created the batch change. For example: projects/{project_number}/locations/{location_id}/enrichmentTasks/{enrichment_task_id}/runs/{enrichment_run_id} + "runTime": "A String", # Optional. The start time of the job run that created the batch change. + }, + }, + "name": "A String", # Required. The resource name of the EntryGroup on which the batch change applies. Format: projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id} +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # This resource represents a long-running operation that is the result of a network API call. + "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available. + "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}. + "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, +}++close()Close httplib2 connections.@@ -130,6 +361,11 @@Method Details
The object takes the form of: { # An Entry Group represents a logical grouping of one or more Entries. + "changeRequestConfig": { # Specifies the configuration for requesting changes in the metadata belonging to the Entry Group. # Optional. Specifies the configuration for requesting changes in the metadata belonging to the Entry Group. + "approverEmails": [ # Optional. Specifies the email addresses of users who are potential approvers and are notified when a change request is created for the metadata belonging to the Entry Group. The maximum number of emails allowed is 10. + "A String", + ], + }, "createTime": "A String", # Output only. The time when the EntryGroup was created. "description": "A String", # Optional. Description of the EntryGroup. "displayName": "A String", # Optional. User friendly display name. @@ -225,6 +461,11 @@Method Details
An object of the form: { # An Entry Group represents a logical grouping of one or more Entries. + "changeRequestConfig": { # Specifies the configuration for requesting changes in the metadata belonging to the Entry Group. # Optional. Specifies the configuration for requesting changes in the metadata belonging to the Entry Group. + "approverEmails": [ # Optional. Specifies the email addresses of users who are potential approvers and are notified when a change request is created for the metadata belonging to the Entry Group. The maximum number of emails allowed is 10. + "A String", + ], + }, "createTime": "A String", # Output only. The time when the EntryGroup was created. "description": "A String", # Optional. Description of the EntryGroup. "displayName": "A String", # Optional. User friendly display name. @@ -308,6 +549,11 @@Method Details
{ # List entry groups response. "entryGroups": [ # Entry groups under the given parent location. { # An Entry Group represents a logical grouping of one or more Entries. + "changeRequestConfig": { # Specifies the configuration for requesting changes in the metadata belonging to the Entry Group. # Optional. Specifies the configuration for requesting changes in the metadata belonging to the Entry Group. + "approverEmails": [ # Optional. Specifies the email addresses of users who are potential approvers and are notified when a change request is created for the metadata belonging to the Entry Group. The maximum number of emails allowed is 10. + "A String", + ], + }, "createTime": "A String", # Output only. The time when the EntryGroup was created. "description": "A String", # Optional. Description of the EntryGroup. "displayName": "A String", # Optional. User friendly display name. @@ -352,6 +598,11 @@Method Details
The object takes the form of: { # An Entry Group represents a logical grouping of one or more Entries. + "changeRequestConfig": { # Specifies the configuration for requesting changes in the metadata belonging to the Entry Group. # Optional. Specifies the configuration for requesting changes in the metadata belonging to the Entry Group. + "approverEmails": [ # Optional. Specifies the email addresses of users who are potential approvers and are notified when a change request is created for the metadata belonging to the Entry Group. The maximum number of emails allowed is 10. + "A String", + ], + }, "createTime": "A String", # Output only. The time when the EntryGroup was created. "description": "A String", # Optional. Description of the EntryGroup. "displayName": "A String", # Optional. User friendly display name. @@ -396,6 +647,221 @@Method Details
}++requestBatchMetadataChange(name, body=None, x__xgafv=None)+Submits a catalog change request for multiple resources within an EntryGroup. This method creates a ChangeRequest resource that must be reviewed and approved before the proposed changes are applied. + +Args: + name: string, Required. The resource name of the Entry Group on which the change applies. Format: projects/{project}/locations/{location}/entryGroups/{entry_group} (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for submitting a set of catalog changes proposals. + "changePayload": { # Request message for batch changing metadata. Requires permission to perform the underlying change, depending on the type and content of the change. Per operation, required permissions are: - for CreateEntry: dataplex.entries.create - for UpdateEntry: dataplex.entries.update - for DeleteEntry: dataplex.entries.delete - for CreateEntryLink: dataplex.entryLinks.create - for UpdateEntryLink: dataplex.entryLinks.update - for DeleteEntryLink: dataplex.entryLinks.deleteAnd per used type permissions are: - for EntryType: dataplex.entryTypes.use or dataplex.entryGroups.useEntry for reusable built-in types, - for AspectType: dataplex.aspectTypes.use or dataplex.entryGroups.useAspect for reusable built-in types and - for EntryLinkType: dataplex.entryLinkTypes.use or dataplex.entryGroups.useEntryLink for reusable built-in types. # Required. The detailed specification of the proposed changes. This payload is intended to be embedded as the change_payload in the resulting ChangeRequest. + "changes": [ # Required. The list of changes to apply. Only a single change per resource is supported. Maximum number of changes supported is 250. + { # Detailed description of an individual change. + "createEntryLinkRequest": { # Request message for CreateEntryLink. # Payload for creating an EntryLink. + "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource. + "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry Link was created. + "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition + "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. + { # Reference to the Entry that is linked through the Entry Link. + "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. + "type": "A String", # Required. Immutable. The reference type of the Entry. + }, + ], + "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "updateTime": "A String", # Output only. The time when the Entry Link was last updated. + }, + "entryLinkId": "A String", # Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup. + "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. + }, + "createEntryRequest": { # Create Entry request. # Payload for creating an Entry. + "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. + }, + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog. + }, + "entryId": "A String", # Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters. + "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}. + }, + "deleteEntryLinkRequest": { # Request message for DeleteEntryLink. # Payload for deleting an EntryLink. + "name": "A String", # Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}. + }, + "deleteEntryRequest": { # Delete Entry request. # Payload for deleting an Entry. + "name": "A String", # Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + }, + "updateEntryLinkRequest": { # Request message for UpdateEntryLink method. # Payload for updating an EntryLink. + "allowMissing": True or False, # Optional. If set to true and the entry link doesn't exist, the service will create it. + "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It should be the aspect type reference in the format {project_id_or_number}.{location_id}.{aspect_type_id}.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. + "A String", + ], + "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource. + "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry Link was created. + "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition + "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. + { # Reference to the Entry that is linked through the Entry Link. + "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. + "type": "A String", # Required. Immutable. The reference type of the Entry. + }, + ], + "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "updateTime": "A String", # Output only. The time when the Entry Link was last updated. + }, + }, + "updateEntryRequest": { # Update Entry request. # Payload for updating an Entry. + "allowMissing": True or False, # Optional. If set to true and the entry doesn't exist, the service will create it. + "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. + "A String", + ], + "deleteMissingAspects": True or False, # Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request. + "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} + "a_key": { # Represents a single piece of metadata describing an entry or entry link. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. + }, + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog. + }, + "updateMask": "A String", # Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request. + }, + }, + ], + "description": { # Description of the batch change. # Optional. Text description of the batch change. + "content": "A String", # Optional. The text description content. + "job": { # Description of the job that created the batch change. # Optional. The job that created the batch change. + "name": "A String", # Optional. The name of the job that created the batch change. For example: projects/{project_number}/locations/{location_id}/enrichmentTasks/{enrichment_task_id}/runs/{enrichment_run_id} + "runTime": "A String", # Optional. The start time of the job run that created the batch change. + }, + }, + "name": "A String", # Required. The resource name of the EntryGroup on which the batch change applies. Format: projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id} + }, + "justification": "A String", # Optional. Justification for the metadata change request. + "labels": { # Optional. User-defined labels for the metadata change request. + "a_key": "A String", + }, +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response message containing the reference to the created change request. + "changeRequest": "A String", # The resource name of the created ChangeRequest. Format: projects/{project}/locations/{location}/changeRequests/{change_request} +}+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. diff --git a/docs/dyn/dataproc_v1.projects.locations.sessionTemplates.html b/docs/dyn/dataproc_v1.projects.locations.sessionTemplates.html index 782ee258bc..79619f32a3 100644 --- a/docs/dyn/dataproc_v1.projects.locations.sessionTemplates.html +++ b/docs/dyn/dataproc_v1.projects.locations.sessionTemplates.html @@ -114,6 +114,7 @@Method Details
"createTime": "A String", # Output only. The time when the template was created. "creator": "A String", # Output only. The email address of the user who created the template. "description": "A String", # Optional. Brief description of the template. + "displayName": "A String", # Optional. User-friendly display name for the session template. Can be up to 63 characters. "environmentConfig": { # Environment configuration for a workload. # Optional. Environment configuration for session execution. "executionConfig": { # Execution configuration for a workload. # Optional. Execution configuration for a workload. "authenticationConfig": { # Authentication configuration for a workload is used to set the default identity for the workload execution. The config specifies the type of identity (service account or user) that will be used by workloads to access resources on the project(s). # Optional. Authentication configuration used to set the default identity for the workload execution. The config specifies the type of identity (service account or user) that will be used by workloads to access resources on the project(s). @@ -184,6 +185,7 @@Method Details
"createTime": "A String", # Output only. The time when the template was created. "creator": "A String", # Output only. The email address of the user who created the template. "description": "A String", # Optional. Brief description of the template. + "displayName": "A String", # Optional. User-friendly display name for the session template. Can be up to 63 characters. "environmentConfig": { # Environment configuration for a workload. # Optional. Environment configuration for session execution. "executionConfig": { # Execution configuration for a workload. # Optional. Execution configuration for a workload. "authenticationConfig": { # Authentication configuration for a workload is used to set the default identity for the workload execution. The config specifies the type of identity (service account or user) that will be used by workloads to access resources on the project(s). # Optional. Authentication configuration used to set the default identity for the workload execution. The config specifies the type of identity (service account or user) that will be used by workloads to access resources on the project(s). @@ -279,6 +281,7 @@Method Details
"createTime": "A String", # Output only. The time when the template was created. "creator": "A String", # Output only. The email address of the user who created the template. "description": "A String", # Optional. Brief description of the template. + "displayName": "A String", # Optional. User-friendly display name for the session template. Can be up to 63 characters. "environmentConfig": { # Environment configuration for a workload. # Optional. Environment configuration for session execution. "executionConfig": { # Execution configuration for a workload. # Optional. Execution configuration for a workload. "authenticationConfig": { # Authentication configuration for a workload is used to set the default identity for the workload execution. The config specifies the type of identity (service account or user) that will be used by workloads to access resources on the project(s). # Optional. Authentication configuration used to set the default identity for the workload execution. The config specifies the type of identity (service account or user) that will be used by workloads to access resources on the project(s). @@ -362,6 +365,7 @@Method Details
"createTime": "A String", # Output only. The time when the template was created. "creator": "A String", # Output only. The email address of the user who created the template. "description": "A String", # Optional. Brief description of the template. + "displayName": "A String", # Optional. User-friendly display name for the session template. Can be up to 63 characters. "environmentConfig": { # Environment configuration for a workload. # Optional. Environment configuration for session execution. "executionConfig": { # Execution configuration for a workload. # Optional. Execution configuration for a workload. "authenticationConfig": { # Authentication configuration for a workload is used to set the default identity for the workload execution. The config specifies the type of identity (service account or user) that will be used by workloads to access resources on the project(s). # Optional. Authentication configuration used to set the default identity for the workload execution. The config specifies the type of identity (service account or user) that will be used by workloads to access resources on the project(s). @@ -450,6 +454,7 @@Method Details
"createTime": "A String", # Output only. The time when the template was created. "creator": "A String", # Output only. The email address of the user who created the template. "description": "A String", # Optional. Brief description of the template. + "displayName": "A String", # Optional. User-friendly display name for the session template. Can be up to 63 characters. "environmentConfig": { # Environment configuration for a workload. # Optional. Environment configuration for session execution. "executionConfig": { # Execution configuration for a workload. # Optional. Execution configuration for a workload. "authenticationConfig": { # Authentication configuration for a workload is used to set the default identity for the workload execution. The config specifies the type of identity (service account or user) that will be used by workloads to access resources on the project(s). # Optional. Authentication configuration used to set the default identity for the workload execution. The config specifies the type of identity (service account or user) that will be used by workloads to access resources on the project(s). @@ -520,6 +525,7 @@Method Details
"createTime": "A String", # Output only. The time when the template was created. "creator": "A String", # Output only. The email address of the user who created the template. "description": "A String", # Optional. Brief description of the template. + "displayName": "A String", # Optional. User-friendly display name for the session template. Can be up to 63 characters. "environmentConfig": { # Environment configuration for a workload. # Optional. Environment configuration for session execution. "executionConfig": { # Execution configuration for a workload. # Optional. Execution configuration for a workload. "authenticationConfig": { # Authentication configuration for a workload is used to set the default identity for the workload execution. The config specifies the type of identity (service account or user) that will be used by workloads to access resources on the project(s). # Optional. Authentication configuration used to set the default identity for the workload execution. The config specifies the type of identity (service account or user) that will be used by workloads to access resources on the project(s). diff --git a/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html b/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html index fcf0fe3347..4405681cca 100644 --- a/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html +++ b/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html @@ -724,6 +724,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "masterFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's master instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration across node groups: * For single-node clusters: master_flexible_config must be specified, and no worker configs should be set. * For multi-node (standard) clusters: both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed.Only one of master_config or master_flexible_config can be set. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "metastoreConfig": { # Specifies a Metastore configuration. # Optional. Metastore configuration. "dataprocMetastoreService": "A String", # Required. Resource name of an existing Metastore service.Example: projects/[project_id]/locations/[dataproc_region]/services/[service-name] }, @@ -818,6 +824,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "secondaryWorkerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for a cluster's secondary worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the secondary worker group and is mutable via cluster updates and autoscaling.Only one of secondary_worker_config or secondary_worker_flexible_config can be set.In High Obtainability (HO) mode, secondary workers are optional. If secondary workers are used in an HO cluster, they must be configured using secondary_worker_flexible_config (not secondary_worker_config). + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. @@ -944,6 +956,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "workerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the worker group and is mutable via cluster updates and autoscaling.Only one of worker_config or worker_flexible_config can be set.In High Obtainability (HO) mode, for multi-node (standard) clusters, both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed. Single-node clusters do not specify worker configs. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, }, "labels": { # Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster. "a_key": "A String", @@ -1561,6 +1579,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "masterFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's master instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration across node groups: * For single-node clusters: master_flexible_config must be specified, and no worker configs should be set. * For multi-node (standard) clusters: both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed.Only one of master_config or master_flexible_config can be set. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "metastoreConfig": { # Specifies a Metastore configuration. # Optional. Metastore configuration. "dataprocMetastoreService": "A String", # Required. Resource name of an existing Metastore service.Example: projects/[project_id]/locations/[dataproc_region]/services/[service-name] }, @@ -1655,6 +1679,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "secondaryWorkerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for a cluster's secondary worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the secondary worker group and is mutable via cluster updates and autoscaling.Only one of secondary_worker_config or secondary_worker_flexible_config can be set.In High Obtainability (HO) mode, secondary workers are optional. If secondary workers are used in an HO cluster, they must be configured using secondary_worker_flexible_config (not secondary_worker_config). + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. @@ -1781,6 +1811,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "workerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the worker group and is mutable via cluster updates and autoscaling.Only one of worker_config or worker_flexible_config can be set.In High Obtainability (HO) mode, for multi-node (standard) clusters, both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed. Single-node clusters do not specify worker configs. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, }, "labels": { # Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster. "a_key": "A String", @@ -2425,6 +2461,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "masterFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's master instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration across node groups: * For single-node clusters: master_flexible_config must be specified, and no worker configs should be set. * For multi-node (standard) clusters: both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed.Only one of master_config or master_flexible_config can be set. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "metastoreConfig": { # Specifies a Metastore configuration. # Optional. Metastore configuration. "dataprocMetastoreService": "A String", # Required. Resource name of an existing Metastore service.Example: projects/[project_id]/locations/[dataproc_region]/services/[service-name] }, @@ -2519,6 +2561,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "secondaryWorkerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for a cluster's secondary worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the secondary worker group and is mutable via cluster updates and autoscaling.Only one of secondary_worker_config or secondary_worker_flexible_config can be set.In High Obtainability (HO) mode, secondary workers are optional. If secondary workers are used in an HO cluster, they must be configured using secondary_worker_flexible_config (not secondary_worker_config). + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. @@ -2645,6 +2693,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "workerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the worker group and is mutable via cluster updates and autoscaling.Only one of worker_config or worker_flexible_config can be set.In High Obtainability (HO) mode, for multi-node (standard) clusters, both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed. Single-node clusters do not specify worker configs. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, }, "labels": { # Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster. "a_key": "A String", @@ -3353,6 +3407,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "masterFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's master instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration across node groups: * For single-node clusters: master_flexible_config must be specified, and no worker configs should be set. * For multi-node (standard) clusters: both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed.Only one of master_config or master_flexible_config can be set. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "metastoreConfig": { # Specifies a Metastore configuration. # Optional. Metastore configuration. "dataprocMetastoreService": "A String", # Required. Resource name of an existing Metastore service.Example: projects/[project_id]/locations/[dataproc_region]/services/[service-name] }, @@ -3447,6 +3507,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "secondaryWorkerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for a cluster's secondary worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the secondary worker group and is mutable via cluster updates and autoscaling.Only one of secondary_worker_config or secondary_worker_flexible_config can be set.In High Obtainability (HO) mode, secondary workers are optional. If secondary workers are used in an HO cluster, they must be configured using secondary_worker_flexible_config (not secondary_worker_config). + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. @@ -3573,6 +3639,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "workerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the worker group and is mutable via cluster updates and autoscaling.Only one of worker_config or worker_flexible_config can be set.In High Obtainability (HO) mode, for multi-node (standard) clusters, both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed. Single-node clusters do not specify worker configs. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, }, "labels": { # Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster. "a_key": "A String", @@ -4231,6 +4303,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "masterFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's master instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration across node groups: * For single-node clusters: master_flexible_config must be specified, and no worker configs should be set. * For multi-node (standard) clusters: both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed.Only one of master_config or master_flexible_config can be set. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "metastoreConfig": { # Specifies a Metastore configuration. # Optional. Metastore configuration. "dataprocMetastoreService": "A String", # Required. Resource name of an existing Metastore service.Example: projects/[project_id]/locations/[dataproc_region]/services/[service-name] }, @@ -4325,6 +4403,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "secondaryWorkerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for a cluster's secondary worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the secondary worker group and is mutable via cluster updates and autoscaling.Only one of secondary_worker_config or secondary_worker_flexible_config can be set.In High Obtainability (HO) mode, secondary workers are optional. If secondary workers are used in an HO cluster, they must be configured using secondary_worker_flexible_config (not secondary_worker_config). + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. @@ -4451,6 +4535,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "workerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the worker group and is mutable via cluster updates and autoscaling.Only one of worker_config or worker_flexible_config can be set.In High Obtainability (HO) mode, for multi-node (standard) clusters, both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed. Single-node clusters do not specify worker configs. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, }, "labels": { # Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster. "a_key": "A String", @@ -5177,6 +5267,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "masterFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's master instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration across node groups: * For single-node clusters: master_flexible_config must be specified, and no worker configs should be set. * For multi-node (standard) clusters: both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed.Only one of master_config or master_flexible_config can be set. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "metastoreConfig": { # Specifies a Metastore configuration. # Optional. Metastore configuration. "dataprocMetastoreService": "A String", # Required. Resource name of an existing Metastore service.Example: projects/[project_id]/locations/[dataproc_region]/services/[service-name] }, @@ -5271,6 +5367,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "secondaryWorkerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for a cluster's secondary worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the secondary worker group and is mutable via cluster updates and autoscaling.Only one of secondary_worker_config or secondary_worker_flexible_config can be set.In High Obtainability (HO) mode, secondary workers are optional. If secondary workers are used in an HO cluster, they must be configured using secondary_worker_flexible_config (not secondary_worker_config). + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. @@ -5397,6 +5499,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "workerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the worker group and is mutable via cluster updates and autoscaling.Only one of worker_config or worker_flexible_config can be set.In High Obtainability (HO) mode, for multi-node (standard) clusters, both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed. Single-node clusters do not specify worker configs. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, }, "labels": { # Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster. "a_key": "A String", @@ -6014,6 +6122,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "masterFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's master instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration across node groups: * For single-node clusters: master_flexible_config must be specified, and no worker configs should be set. * For multi-node (standard) clusters: both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed.Only one of master_config or master_flexible_config can be set. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "metastoreConfig": { # Specifies a Metastore configuration. # Optional. Metastore configuration. "dataprocMetastoreService": "A String", # Required. Resource name of an existing Metastore service.Example: projects/[project_id]/locations/[dataproc_region]/services/[service-name] }, @@ -6108,6 +6222,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "secondaryWorkerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for a cluster's secondary worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the secondary worker group and is mutable via cluster updates and autoscaling.Only one of secondary_worker_config or secondary_worker_flexible_config can be set.In High Obtainability (HO) mode, secondary workers are optional. If secondary workers are used in an HO cluster, they must be configured using secondary_worker_flexible_config (not secondary_worker_config). + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. @@ -6234,6 +6354,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "workerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the worker group and is mutable via cluster updates and autoscaling.Only one of worker_config or worker_flexible_config can be set.In High Obtainability (HO) mode, for multi-node (standard) clusters, both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed. Single-node clusters do not specify worker configs. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, }, "labels": { # Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster. "a_key": "A String", diff --git a/docs/dyn/dataproc_v1.projects.regions.clusters.html b/docs/dyn/dataproc_v1.projects.regions.clusters.html index 6b7e32cee3..87df5c1e5e 100644 --- a/docs/dyn/dataproc_v1.projects.regions.clusters.html +++ b/docs/dyn/dataproc_v1.projects.regions.clusters.html @@ -468,6 +468,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "masterFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's master instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration across node groups: * For single-node clusters: master_flexible_config must be specified, and no worker configs should be set. * For multi-node (standard) clusters: both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed.Only one of master_config or master_flexible_config can be set. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "metastoreConfig": { # Specifies a Metastore configuration. # Optional. Metastore configuration. "dataprocMetastoreService": "A String", # Required. Resource name of an existing Metastore service.Example: projects/[project_id]/locations/[dataproc_region]/services/[service-name] }, @@ -562,6 +568,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "secondaryWorkerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for a cluster's secondary worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the secondary worker group and is mutable via cluster updates and autoscaling.Only one of secondary_worker_config or secondary_worker_flexible_config can be set.In High Obtainability (HO) mode, secondary workers are optional. If secondary workers are used in an HO cluster, they must be configured using secondary_worker_flexible_config (not secondary_worker_config). + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. @@ -688,6 +700,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "workerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the worker group and is mutable via cluster updates and autoscaling.Only one of worker_config or worker_flexible_config can be set.In High Obtainability (HO) mode, for multi-node (standard) clusters, both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed. Single-node clusters do not specify worker configs. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, }, "labels": { # Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster. "a_key": "A String", @@ -1255,6 +1273,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "masterFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's master instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration across node groups: * For single-node clusters: master_flexible_config must be specified, and no worker configs should be set. * For multi-node (standard) clusters: both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed.Only one of master_config or master_flexible_config can be set. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "metastoreConfig": { # Specifies a Metastore configuration. # Optional. Metastore configuration. "dataprocMetastoreService": "A String", # Required. Resource name of an existing Metastore service.Example: projects/[project_id]/locations/[dataproc_region]/services/[service-name] }, @@ -1349,6 +1373,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "secondaryWorkerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for a cluster's secondary worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the secondary worker group and is mutable via cluster updates and autoscaling.Only one of secondary_worker_config or secondary_worker_flexible_config can be set.In High Obtainability (HO) mode, secondary workers are optional. If secondary workers are used in an HO cluster, they must be configured using secondary_worker_flexible_config (not secondary_worker_config). + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. @@ -1475,6 +1505,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "workerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the worker group and is mutable via cluster updates and autoscaling.Only one of worker_config or worker_flexible_config can be set.In High Obtainability (HO) mode, for multi-node (standard) clusters, both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed. Single-node clusters do not specify worker configs. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, }, "labels": { # Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster. "a_key": "A String", @@ -2003,6 +2039,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "masterFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's master instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration across node groups: * For single-node clusters: master_flexible_config must be specified, and no worker configs should be set. * For multi-node (standard) clusters: both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed.Only one of master_config or master_flexible_config can be set. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "metastoreConfig": { # Specifies a Metastore configuration. # Optional. Metastore configuration. "dataprocMetastoreService": "A String", # Required. Resource name of an existing Metastore service.Example: projects/[project_id]/locations/[dataproc_region]/services/[service-name] }, @@ -2097,6 +2139,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "secondaryWorkerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for a cluster's secondary worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the secondary worker group and is mutable via cluster updates and autoscaling.Only one of secondary_worker_config or secondary_worker_flexible_config can be set.In High Obtainability (HO) mode, secondary workers are optional. If secondary workers are used in an HO cluster, they must be configured using secondary_worker_flexible_config (not secondary_worker_config). + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. @@ -2223,6 +2271,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "workerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the worker group and is mutable via cluster updates and autoscaling.Only one of worker_config or worker_flexible_config can be set.In High Obtainability (HO) mode, for multi-node (standard) clusters, both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed. Single-node clusters do not specify worker configs. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, }, "labels": { # Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster. "a_key": "A String", @@ -2671,6 +2725,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "masterFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's master instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration across node groups: * For single-node clusters: master_flexible_config must be specified, and no worker configs should be set. * For multi-node (standard) clusters: both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed.Only one of master_config or master_flexible_config can be set. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "metastoreConfig": { # Specifies a Metastore configuration. # Optional. Metastore configuration. "dataprocMetastoreService": "A String", # Required. Resource name of an existing Metastore service.Example: projects/[project_id]/locations/[dataproc_region]/services/[service-name] }, @@ -2765,6 +2825,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "secondaryWorkerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for a cluster's secondary worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the secondary worker group and is mutable via cluster updates and autoscaling.Only one of secondary_worker_config or secondary_worker_flexible_config can be set.In High Obtainability (HO) mode, secondary workers are optional. If secondary workers are used in an HO cluster, they must be configured using secondary_worker_flexible_config (not secondary_worker_config). + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. @@ -2891,6 +2957,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "workerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the worker group and is mutable via cluster updates and autoscaling.Only one of worker_config or worker_flexible_config can be set.In High Obtainability (HO) mode, for multi-node (standard) clusters, both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed. Single-node clusters do not specify worker configs. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, }, "labels": { # Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster. "a_key": "A String", diff --git a/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html b/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html index f5e2a2d21c..2cfe1cac09 100644 --- a/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html +++ b/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html @@ -724,6 +724,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "masterFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's master instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration across node groups: * For single-node clusters: master_flexible_config must be specified, and no worker configs should be set. * For multi-node (standard) clusters: both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed.Only one of master_config or master_flexible_config can be set. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "metastoreConfig": { # Specifies a Metastore configuration. # Optional. Metastore configuration. "dataprocMetastoreService": "A String", # Required. Resource name of an existing Metastore service.Example: projects/[project_id]/locations/[dataproc_region]/services/[service-name] }, @@ -818,6 +824,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "secondaryWorkerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for a cluster's secondary worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the secondary worker group and is mutable via cluster updates and autoscaling.Only one of secondary_worker_config or secondary_worker_flexible_config can be set.In High Obtainability (HO) mode, secondary workers are optional. If secondary workers are used in an HO cluster, they must be configured using secondary_worker_flexible_config (not secondary_worker_config). + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. @@ -944,6 +956,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "workerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the worker group and is mutable via cluster updates and autoscaling.Only one of worker_config or worker_flexible_config can be set.In High Obtainability (HO) mode, for multi-node (standard) clusters, both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed. Single-node clusters do not specify worker configs. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, }, "labels": { # Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster. "a_key": "A String", @@ -1561,6 +1579,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "masterFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's master instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration across node groups: * For single-node clusters: master_flexible_config must be specified, and no worker configs should be set. * For multi-node (standard) clusters: both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed.Only one of master_config or master_flexible_config can be set. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "metastoreConfig": { # Specifies a Metastore configuration. # Optional. Metastore configuration. "dataprocMetastoreService": "A String", # Required. Resource name of an existing Metastore service.Example: projects/[project_id]/locations/[dataproc_region]/services/[service-name] }, @@ -1655,6 +1679,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "secondaryWorkerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for a cluster's secondary worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the secondary worker group and is mutable via cluster updates and autoscaling.Only one of secondary_worker_config or secondary_worker_flexible_config can be set.In High Obtainability (HO) mode, secondary workers are optional. If secondary workers are used in an HO cluster, they must be configured using secondary_worker_flexible_config (not secondary_worker_config). + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. @@ -1781,6 +1811,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "workerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the worker group and is mutable via cluster updates and autoscaling.Only one of worker_config or worker_flexible_config can be set.In High Obtainability (HO) mode, for multi-node (standard) clusters, both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed. Single-node clusters do not specify worker configs. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, }, "labels": { # Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster. "a_key": "A String", @@ -2425,6 +2461,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "masterFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's master instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration across node groups: * For single-node clusters: master_flexible_config must be specified, and no worker configs should be set. * For multi-node (standard) clusters: both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed.Only one of master_config or master_flexible_config can be set. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "metastoreConfig": { # Specifies a Metastore configuration. # Optional. Metastore configuration. "dataprocMetastoreService": "A String", # Required. Resource name of an existing Metastore service.Example: projects/[project_id]/locations/[dataproc_region]/services/[service-name] }, @@ -2519,6 +2561,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "secondaryWorkerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for a cluster's secondary worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the secondary worker group and is mutable via cluster updates and autoscaling.Only one of secondary_worker_config or secondary_worker_flexible_config can be set.In High Obtainability (HO) mode, secondary workers are optional. If secondary workers are used in an HO cluster, they must be configured using secondary_worker_flexible_config (not secondary_worker_config). + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. @@ -2645,6 +2693,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "workerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the worker group and is mutable via cluster updates and autoscaling.Only one of worker_config or worker_flexible_config can be set.In High Obtainability (HO) mode, for multi-node (standard) clusters, both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed. Single-node clusters do not specify worker configs. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, }, "labels": { # Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster. "a_key": "A String", @@ -3353,6 +3407,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "masterFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's master instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration across node groups: * For single-node clusters: master_flexible_config must be specified, and no worker configs should be set. * For multi-node (standard) clusters: both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed.Only one of master_config or master_flexible_config can be set. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "metastoreConfig": { # Specifies a Metastore configuration. # Optional. Metastore configuration. "dataprocMetastoreService": "A String", # Required. Resource name of an existing Metastore service.Example: projects/[project_id]/locations/[dataproc_region]/services/[service-name] }, @@ -3447,6 +3507,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "secondaryWorkerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for a cluster's secondary worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the secondary worker group and is mutable via cluster updates and autoscaling.Only one of secondary_worker_config or secondary_worker_flexible_config can be set.In High Obtainability (HO) mode, secondary workers are optional. If secondary workers are used in an HO cluster, they must be configured using secondary_worker_flexible_config (not secondary_worker_config). + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. @@ -3573,6 +3639,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "workerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the worker group and is mutable via cluster updates and autoscaling.Only one of worker_config or worker_flexible_config can be set.In High Obtainability (HO) mode, for multi-node (standard) clusters, both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed. Single-node clusters do not specify worker configs. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, }, "labels": { # Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster. "a_key": "A String", @@ -4231,6 +4303,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "masterFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's master instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration across node groups: * For single-node clusters: master_flexible_config must be specified, and no worker configs should be set. * For multi-node (standard) clusters: both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed.Only one of master_config or master_flexible_config can be set. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "metastoreConfig": { # Specifies a Metastore configuration. # Optional. Metastore configuration. "dataprocMetastoreService": "A String", # Required. Resource name of an existing Metastore service.Example: projects/[project_id]/locations/[dataproc_region]/services/[service-name] }, @@ -4325,6 +4403,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "secondaryWorkerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for a cluster's secondary worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the secondary worker group and is mutable via cluster updates and autoscaling.Only one of secondary_worker_config or secondary_worker_flexible_config can be set.In High Obtainability (HO) mode, secondary workers are optional. If secondary workers are used in an HO cluster, they must be configured using secondary_worker_flexible_config (not secondary_worker_config). + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. @@ -4451,6 +4535,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "workerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the worker group and is mutable via cluster updates and autoscaling.Only one of worker_config or worker_flexible_config can be set.In High Obtainability (HO) mode, for multi-node (standard) clusters, both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed. Single-node clusters do not specify worker configs. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, }, "labels": { # Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster. "a_key": "A String", @@ -5177,6 +5267,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "masterFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's master instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration across node groups: * For single-node clusters: master_flexible_config must be specified, and no worker configs should be set. * For multi-node (standard) clusters: both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed.Only one of master_config or master_flexible_config can be set. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "metastoreConfig": { # Specifies a Metastore configuration. # Optional. Metastore configuration. "dataprocMetastoreService": "A String", # Required. Resource name of an existing Metastore service.Example: projects/[project_id]/locations/[dataproc_region]/services/[service-name] }, @@ -5271,6 +5367,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "secondaryWorkerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for a cluster's secondary worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the secondary worker group and is mutable via cluster updates and autoscaling.Only one of secondary_worker_config or secondary_worker_flexible_config can be set.In High Obtainability (HO) mode, secondary workers are optional. If secondary workers are used in an HO cluster, they must be configured using secondary_worker_flexible_config (not secondary_worker_config). + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. @@ -5397,6 +5499,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "workerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the worker group and is mutable via cluster updates and autoscaling.Only one of worker_config or worker_flexible_config can be set.In High Obtainability (HO) mode, for multi-node (standard) clusters, both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed. Single-node clusters do not specify worker configs. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, }, "labels": { # Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster. "a_key": "A String", @@ -6014,6 +6122,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "masterFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's master instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration across node groups: * For single-node clusters: master_flexible_config must be specified, and no worker configs should be set. * For multi-node (standard) clusters: both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed.Only one of master_config or master_flexible_config can be set. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "metastoreConfig": { # Specifies a Metastore configuration. # Optional. Metastore configuration. "dataprocMetastoreService": "A String", # Required. Resource name of an existing Metastore service.Example: projects/[project_id]/locations/[dataproc_region]/services/[service-name] }, @@ -6108,6 +6222,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "secondaryWorkerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for a cluster's secondary worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the secondary worker group and is mutable via cluster updates and autoscaling.Only one of secondary_worker_config or secondary_worker_flexible_config can be set.In High Obtainability (HO) mode, secondary workers are optional. If secondary workers are used in an HO cluster, they must be configured using secondary_worker_flexible_config (not secondary_worker_config). + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. @@ -6234,6 +6354,12 @@Method Details
"requiredRegistrationFraction": 3.14, # Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). }, }, + "workerFlexibleConfig": { # The configuration for High Obtainability (HO) flexible instance groups. Flexible instance group configs serve as the single source of truth for desired state. # Optional. The High Obtainability (HO) config settings for the cluster's worker instances.In High Obtainability (HO) mode, flexible configs are the single source of truth for desired cluster configuration. num_instances represents the desired capacity of the worker group and is mutable via cluster updates and autoscaling.Only one of worker_config or worker_flexible_config can be set.In High Obtainability (HO) mode, for multi-node (standard) clusters, both master_flexible_config and worker_flexible_config must be specified. Mixing standard and flexible configs across node groups is not allowed. Single-node clusters do not specify worker configs. + "bootDiskSizeGb": 42, # Optional. The boot disk size in GB. This is a create-time specification and is not currently mutable via update masks. + "coreCount": 42, # Optional. The number of vCPUs per instance. Must be a power of 2 (2, 4, 8, 16, 32). This is a create-time specification and is not currently mutable via update masks. + "hardwareClass": "A String", # Optional. The hardware class of the instances. This is a create-time specification and is not currently mutable via update masks. + "numInstances": 42, # Optional. The number of VM instances requested.For master instances, this must be 1. For worker and secondary worker instances, this represents the desired capacity of the group and is mutable via cluster update operations and autoscaling. + }, }, "labels": { # Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster. "a_key": "A String", diff --git a/docs/dyn/devicerun_v1alpha.projects.locations.sessions.html b/docs/dyn/devicerun_v1alpha.projects.locations.sessions.html index d014b44249..826e0f17cd 100644 --- a/docs/dyn/devicerun_v1alpha.projects.locations.sessions.html +++ b/docs/dyn/devicerun_v1alpha.projects.locations.sessions.html @@ -117,6 +117,7 @@Method Details
{ # Response including the requested sessions. "sessions": [ # The requested sessions, in the same order as the `names` in the request. { # A session resource in the AutomationSession API. At a high level, `Session` describes the configuration of one or multiple jobs, the state transitions it goes through, and the results. + "createTime": "A String", # Output only. The time when the session was created. "name": "A String", # Identifier. The resource name of the session. Format: `projects/{project}/locations/{location}/sessions/{session}`. "sessionConfig": { # SessionConfig is used to create a session. # Required. Configuration used to create the session. "displayName": "A String", # Optional. User-settable, human-readable name for the session. Maximum size is 63 bytes when encoded as UTF-8. If set, must match regex: `^A-Za-z0-9*$`. @@ -191,10 +192,10 @@Method Details
"actions": [ # Optional. The actions to be performed on the device. Actions will be executed in the order they are specified in the list. Each action type can at most have 1 instance in the list. { # The action to be performed on a device. "androidBugreport": { # Captures a bugreport from the device. The output will be written to a file named `bugreport.zip` in the execution output directory. # Captures a bugreport from the device unless the test result is pass. - "collectOnPass": True or False, # Optional. Whether to deliver the bugreport when the test passes. If false, the bugreport is skipped on pass to save time (default behavior). If true, the bugreport is always delivered. + "collectOnPass": True or False, # Optional. Whether to deliver the bugreport when the test passes. If `false`, the bugreport is skipped on pass to save time (default behavior). If `true`, the bugreport is always delivered. }, "androidDumpsys": { # Captures dumpsys output from the device. The output will be written to a file named `dumpsys.log` in the execution output directory. # Captures a dumpsys from the device. - "collectOnPass": True or False, # Optional. Whether to deliver the dumpsys when the test passes. If false, the dumpsys is skipped on pass to save time (default behavior). If true, the dumpsys is always delivered. + "collectOnPass": True or False, # Optional. Whether to deliver the dumpsys when the test passes. If `false`, the dumpsys is skipped on pass to save time (default behavior). If `true`, the dumpsys is always delivered. }, "androidInstallPackages": { # Installs Android packages on the device. At least one installable is specified when using this device action. Limits: - A maximum of 20 installables in total are allowed. - A maximum of 100 files are allowed in total across all installables. # Installs Android packages on the device. "installables": [ # Optional. Deprecated: use `pre_target_app_installables`, `target_app` and `post_target_app_installables` instead. The Android packages to install on the device. The installation will be performed in the order specified, before the installables of all other fields. @@ -269,7 +270,7 @@Method Details
], }, "androidRecordVideo": { # Records a video of the device screen during the run. The video will be written to a file named `video.mp4` in the execution output directory. # Records a video of the device screen during the run. - "discardOnPass": True or False, # Optional. Whether to discard and not upload the recording when the test passes. Default is false. + "discardOnPass": True or False, # Optional. Whether to discard and not upload the recording when the test passes. Default is `false`. }, "androidSwitchLocale": { # Switches the locale (language and region) of the device. # Switches the locale (language and region) of the device. "localeCode": "A String", # Required. The locale (language and region) to switch the device to. The format is `language-region`, e.g. "en-US", "zh-CN", etc. The typical language value is a two or three-letter language code as defined in ISO639. The typical region value is a two-letter ISO 3166 code or a three-digit UN M.49 area code. @@ -306,8 +307,8 @@Method Details
}, ], }, - "iosRecordVideo": { # Records a video of the iOS device screen during the run. The video will be written to a file named `video.mp4` in the execution output directory. # Records a video of the iOS device screen during the run. - "discardOnPass": True or False, # Optional. Whether to discard the video if the test passes. If not specified, the default is false (always keep the video). + "iosRecordVideo": { # Records videos of the iOS device screen, one per UI test case. Each video covers only the execution of its test case, and will be written to `testcases/{test_class}/{test_method}/video.mp4` in the execution output directory. No video is recorded for unit tests, or on devices running a version earlier than iOS 17. # Records videos of the iOS device screen, one per UI test case. + "discardOnPass": True or False, # Optional. Whether to discard the video of a test case when it passes. If not specified, the default is `false` (videos of all test cases are kept). }, "iosSwitchLocale": { # Switches the locale (language and region) of the iOS application. # Switches the locale (language and region) of the iOS application. "localeCode": "A String", # Required. The locale (language and region) to switch the app to. The format is `language-region` or `language`, e.g. "en-US", "zh-CN", "ja", etc. @@ -370,6 +371,9 @@Method Details
"cause": { # Describes the cause of the non-passed result occurred during the execution. # Output only. Detailed result cause diagnostics. Set if type is not PASSED. "summary": { # Describes the summary of an issue (error or warning) with structured details. # Output only. Structured cause detail. "message": "A String", # Output only. Human-readable explanation of the issue in English. + "metadata": { # Output only. Additional metadata about the issue. + "a_key": "A String", + }, "reason": "A String", # Output only. The reason of the issue. This is a constant value that identifies the proximate cause of the issue. This should be at most 63 characters and match a regular expression of `A-Z*[A-Z0-9]`, which represents UPPER_SNAKE_CASE. "type": "A String", # Output only. The issue classification based on responsibility. }, @@ -387,6 +391,9 @@Method Details
{ # Non-fatal operational anomaly, lint observation, or execution insight. "summary": { # Describes the summary of an issue (error or warning) with structured details. # Output only. Detailed warning summary. "message": "A String", # Output only. Human-readable explanation of the issue in English. + "metadata": { # Output only. Additional metadata about the issue. + "a_key": "A String", + }, "reason": "A String", # Output only. The reason of the issue. This is a constant value that identifies the proximate cause of the issue. This should be at most 63 characters and match a regular expression of `A-Z*[A-Z0-9]`, which represents UPPER_SNAKE_CASE. "type": "A String", # Output only. The issue classification based on responsibility. }, @@ -409,6 +416,9 @@Method Details
"cause": { # Describes the cause of the non-passed result occurred during the execution. # Output only. Detailed result cause diagnostics. Set if type is not PASSED. "summary": { # Describes the summary of an issue (error or warning) with structured details. # Output only. Structured cause detail. "message": "A String", # Output only. Human-readable explanation of the issue in English. + "metadata": { # Output only. Additional metadata about the issue. + "a_key": "A String", + }, "reason": "A String", # Output only. The reason of the issue. This is a constant value that identifies the proximate cause of the issue. This should be at most 63 characters and match a regular expression of `A-Z*[A-Z0-9]`, which represents UPPER_SNAKE_CASE. "type": "A String", # Output only. The issue classification based on responsibility. }, @@ -426,6 +436,9 @@Method Details
{ # Non-fatal operational anomaly, lint observation, or execution insight. "summary": { # Describes the summary of an issue (error or warning) with structured details. # Output only. Detailed warning summary. "message": "A String", # Output only. Human-readable explanation of the issue in English. + "metadata": { # Output only. Additional metadata about the issue. + "a_key": "A String", + }, "reason": "A String", # Output only. The reason of the issue. This is a constant value that identifies the proximate cause of the issue. This should be at most 63 characters and match a regular expression of `A-Z*[A-Z0-9]`, which represents UPPER_SNAKE_CASE. "type": "A String", # Output only. The issue classification based on responsibility. }, @@ -437,6 +450,9 @@Method Details
"cause": { # Describes the cause of the non-passed result occurred during the execution. # Output only. Detailed result cause diagnostics. Set if type is not PASSED. "summary": { # Describes the summary of an issue (error or warning) with structured details. # Output only. Structured cause detail. "message": "A String", # Output only. Human-readable explanation of the issue in English. + "metadata": { # Output only. Additional metadata about the issue. + "a_key": "A String", + }, "reason": "A String", # Output only. The reason of the issue. This is a constant value that identifies the proximate cause of the issue. This should be at most 63 characters and match a regular expression of `A-Z*[A-Z0-9]`, which represents UPPER_SNAKE_CASE. "type": "A String", # Output only. The issue classification based on responsibility. }, @@ -496,6 +512,7 @@Method Details
The object takes the form of: { # A session resource in the AutomationSession API. At a high level, `Session` describes the configuration of one or multiple jobs, the state transitions it goes through, and the results. + "createTime": "A String", # Output only. The time when the session was created. "name": "A String", # Identifier. The resource name of the session. Format: `projects/{project}/locations/{location}/sessions/{session}`. "sessionConfig": { # SessionConfig is used to create a session. # Required. Configuration used to create the session. "displayName": "A String", # Optional. User-settable, human-readable name for the session. Maximum size is 63 bytes when encoded as UTF-8. If set, must match regex: `^A-Za-z0-9*$`. @@ -570,10 +587,10 @@Method Details
"actions": [ # Optional. The actions to be performed on the device. Actions will be executed in the order they are specified in the list. Each action type can at most have 1 instance in the list. { # The action to be performed on a device. "androidBugreport": { # Captures a bugreport from the device. The output will be written to a file named `bugreport.zip` in the execution output directory. # Captures a bugreport from the device unless the test result is pass. - "collectOnPass": True or False, # Optional. Whether to deliver the bugreport when the test passes. If false, the bugreport is skipped on pass to save time (default behavior). If true, the bugreport is always delivered. + "collectOnPass": True or False, # Optional. Whether to deliver the bugreport when the test passes. If `false`, the bugreport is skipped on pass to save time (default behavior). If `true`, the bugreport is always delivered. }, "androidDumpsys": { # Captures dumpsys output from the device. The output will be written to a file named `dumpsys.log` in the execution output directory. # Captures a dumpsys from the device. - "collectOnPass": True or False, # Optional. Whether to deliver the dumpsys when the test passes. If false, the dumpsys is skipped on pass to save time (default behavior). If true, the dumpsys is always delivered. + "collectOnPass": True or False, # Optional. Whether to deliver the dumpsys when the test passes. If `false`, the dumpsys is skipped on pass to save time (default behavior). If `true`, the dumpsys is always delivered. }, "androidInstallPackages": { # Installs Android packages on the device. At least one installable is specified when using this device action. Limits: - A maximum of 20 installables in total are allowed. - A maximum of 100 files are allowed in total across all installables. # Installs Android packages on the device. "installables": [ # Optional. Deprecated: use `pre_target_app_installables`, `target_app` and `post_target_app_installables` instead. The Android packages to install on the device. The installation will be performed in the order specified, before the installables of all other fields. @@ -648,7 +665,7 @@Method Details
], }, "androidRecordVideo": { # Records a video of the device screen during the run. The video will be written to a file named `video.mp4` in the execution output directory. # Records a video of the device screen during the run. - "discardOnPass": True or False, # Optional. Whether to discard and not upload the recording when the test passes. Default is false. + "discardOnPass": True or False, # Optional. Whether to discard and not upload the recording when the test passes. Default is `false`. }, "androidSwitchLocale": { # Switches the locale (language and region) of the device. # Switches the locale (language and region) of the device. "localeCode": "A String", # Required. The locale (language and region) to switch the device to. The format is `language-region`, e.g. "en-US", "zh-CN", etc. The typical language value is a two or three-letter language code as defined in ISO639. The typical region value is a two-letter ISO 3166 code or a three-digit UN M.49 area code. @@ -685,8 +702,8 @@Method Details
}, ], }, - "iosRecordVideo": { # Records a video of the iOS device screen during the run. The video will be written to a file named `video.mp4` in the execution output directory. # Records a video of the iOS device screen during the run. - "discardOnPass": True or False, # Optional. Whether to discard the video if the test passes. If not specified, the default is false (always keep the video). + "iosRecordVideo": { # Records videos of the iOS device screen, one per UI test case. Each video covers only the execution of its test case, and will be written to `testcases/{test_class}/{test_method}/video.mp4` in the execution output directory. No video is recorded for unit tests, or on devices running a version earlier than iOS 17. # Records videos of the iOS device screen, one per UI test case. + "discardOnPass": True or False, # Optional. Whether to discard the video of a test case when it passes. If not specified, the default is `false` (videos of all test cases are kept). }, "iosSwitchLocale": { # Switches the locale (language and region) of the iOS application. # Switches the locale (language and region) of the iOS application. "localeCode": "A String", # Required. The locale (language and region) to switch the app to. The format is `language-region` or `language`, e.g. "en-US", "zh-CN", "ja", etc. @@ -749,6 +766,9 @@Method Details
"cause": { # Describes the cause of the non-passed result occurred during the execution. # Output only. Detailed result cause diagnostics. Set if type is not PASSED. "summary": { # Describes the summary of an issue (error or warning) with structured details. # Output only. Structured cause detail. "message": "A String", # Output only. Human-readable explanation of the issue in English. + "metadata": { # Output only. Additional metadata about the issue. + "a_key": "A String", + }, "reason": "A String", # Output only. The reason of the issue. This is a constant value that identifies the proximate cause of the issue. This should be at most 63 characters and match a regular expression of `A-Z*[A-Z0-9]`, which represents UPPER_SNAKE_CASE. "type": "A String", # Output only. The issue classification based on responsibility. }, @@ -766,6 +786,9 @@Method Details
{ # Non-fatal operational anomaly, lint observation, or execution insight. "summary": { # Describes the summary of an issue (error or warning) with structured details. # Output only. Detailed warning summary. "message": "A String", # Output only. Human-readable explanation of the issue in English. + "metadata": { # Output only. Additional metadata about the issue. + "a_key": "A String", + }, "reason": "A String", # Output only. The reason of the issue. This is a constant value that identifies the proximate cause of the issue. This should be at most 63 characters and match a regular expression of `A-Z*[A-Z0-9]`, which represents UPPER_SNAKE_CASE. "type": "A String", # Output only. The issue classification based on responsibility. }, @@ -788,6 +811,9 @@Method Details
"cause": { # Describes the cause of the non-passed result occurred during the execution. # Output only. Detailed result cause diagnostics. Set if type is not PASSED. "summary": { # Describes the summary of an issue (error or warning) with structured details. # Output only. Structured cause detail. "message": "A String", # Output only. Human-readable explanation of the issue in English. + "metadata": { # Output only. Additional metadata about the issue. + "a_key": "A String", + }, "reason": "A String", # Output only. The reason of the issue. This is a constant value that identifies the proximate cause of the issue. This should be at most 63 characters and match a regular expression of `A-Z*[A-Z0-9]`, which represents UPPER_SNAKE_CASE. "type": "A String", # Output only. The issue classification based on responsibility. }, @@ -805,6 +831,9 @@Method Details
{ # Non-fatal operational anomaly, lint observation, or execution insight. "summary": { # Describes the summary of an issue (error or warning) with structured details. # Output only. Detailed warning summary. "message": "A String", # Output only. Human-readable explanation of the issue in English. + "metadata": { # Output only. Additional metadata about the issue. + "a_key": "A String", + }, "reason": "A String", # Output only. The reason of the issue. This is a constant value that identifies the proximate cause of the issue. This should be at most 63 characters and match a regular expression of `A-Z*[A-Z0-9]`, which represents UPPER_SNAKE_CASE. "type": "A String", # Output only. The issue classification based on responsibility. }, @@ -816,6 +845,9 @@Method Details
"cause": { # Describes the cause of the non-passed result occurred during the execution. # Output only. Detailed result cause diagnostics. Set if type is not PASSED. "summary": { # Describes the summary of an issue (error or warning) with structured details. # Output only. Structured cause detail. "message": "A String", # Output only. Human-readable explanation of the issue in English. + "metadata": { # Output only. Additional metadata about the issue. + "a_key": "A String", + }, "reason": "A String", # Output only. The reason of the issue. This is a constant value that identifies the proximate cause of the issue. This should be at most 63 characters and match a regular expression of `A-Z*[A-Z0-9]`, which represents UPPER_SNAKE_CASE. "type": "A String", # Output only. The issue classification based on responsibility. }, @@ -905,11 +937,11 @@Method Details
Args: name: string, Required. The name of the session. Format: `projects/{project}/locations/{location}/sessions/{session}`. (required) - view: string, Optional. The view of the session to return. If not set, the default BASIC view will be returned. + view: string, Optional. The view of the session to return. If not set, the `FULL` view will be returned. Allowed values - SESSION_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view. - SESSION_VIEW_BASIC - Include basic view of the session but not the full contents. Only the uid/display_name/status/result of the session and its jobs/executions will be included. This is the default value (for GetSession). - SESSION_VIEW_FULL - Include everything. + SESSION_VIEW_UNSPECIFIED - The default / unset value. The API will default to the FULL view. + SESSION_VIEW_BASIC - Include basic view of the session but not the full contents. Only the uid/display_name/status/result of the session and its jobs/executions will be included. + SESSION_VIEW_FULL - Include everything. This is the default value. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -919,6 +951,7 @@Method Details
An object of the form: { # A session resource in the AutomationSession API. At a high level, `Session` describes the configuration of one or multiple jobs, the state transitions it goes through, and the results. + "createTime": "A String", # Output only. The time when the session was created. "name": "A String", # Identifier. The resource name of the session. Format: `projects/{project}/locations/{location}/sessions/{session}`. "sessionConfig": { # SessionConfig is used to create a session. # Required. Configuration used to create the session. "displayName": "A String", # Optional. User-settable, human-readable name for the session. Maximum size is 63 bytes when encoded as UTF-8. If set, must match regex: `^A-Za-z0-9*$`. @@ -993,10 +1026,10 @@Method Details
"actions": [ # Optional. The actions to be performed on the device. Actions will be executed in the order they are specified in the list. Each action type can at most have 1 instance in the list. { # The action to be performed on a device. "androidBugreport": { # Captures a bugreport from the device. The output will be written to a file named `bugreport.zip` in the execution output directory. # Captures a bugreport from the device unless the test result is pass. - "collectOnPass": True or False, # Optional. Whether to deliver the bugreport when the test passes. If false, the bugreport is skipped on pass to save time (default behavior). If true, the bugreport is always delivered. + "collectOnPass": True or False, # Optional. Whether to deliver the bugreport when the test passes. If `false`, the bugreport is skipped on pass to save time (default behavior). If `true`, the bugreport is always delivered. }, "androidDumpsys": { # Captures dumpsys output from the device. The output will be written to a file named `dumpsys.log` in the execution output directory. # Captures a dumpsys from the device. - "collectOnPass": True or False, # Optional. Whether to deliver the dumpsys when the test passes. If false, the dumpsys is skipped on pass to save time (default behavior). If true, the dumpsys is always delivered. + "collectOnPass": True or False, # Optional. Whether to deliver the dumpsys when the test passes. If `false`, the dumpsys is skipped on pass to save time (default behavior). If `true`, the dumpsys is always delivered. }, "androidInstallPackages": { # Installs Android packages on the device. At least one installable is specified when using this device action. Limits: - A maximum of 20 installables in total are allowed. - A maximum of 100 files are allowed in total across all installables. # Installs Android packages on the device. "installables": [ # Optional. Deprecated: use `pre_target_app_installables`, `target_app` and `post_target_app_installables` instead. The Android packages to install on the device. The installation will be performed in the order specified, before the installables of all other fields. @@ -1071,7 +1104,7 @@Method Details
], }, "androidRecordVideo": { # Records a video of the device screen during the run. The video will be written to a file named `video.mp4` in the execution output directory. # Records a video of the device screen during the run. - "discardOnPass": True or False, # Optional. Whether to discard and not upload the recording when the test passes. Default is false. + "discardOnPass": True or False, # Optional. Whether to discard and not upload the recording when the test passes. Default is `false`. }, "androidSwitchLocale": { # Switches the locale (language and region) of the device. # Switches the locale (language and region) of the device. "localeCode": "A String", # Required. The locale (language and region) to switch the device to. The format is `language-region`, e.g. "en-US", "zh-CN", etc. The typical language value is a two or three-letter language code as defined in ISO639. The typical region value is a two-letter ISO 3166 code or a three-digit UN M.49 area code. @@ -1108,8 +1141,8 @@Method Details
}, ], }, - "iosRecordVideo": { # Records a video of the iOS device screen during the run. The video will be written to a file named `video.mp4` in the execution output directory. # Records a video of the iOS device screen during the run. - "discardOnPass": True or False, # Optional. Whether to discard the video if the test passes. If not specified, the default is false (always keep the video). + "iosRecordVideo": { # Records videos of the iOS device screen, one per UI test case. Each video covers only the execution of its test case, and will be written to `testcases/{test_class}/{test_method}/video.mp4` in the execution output directory. No video is recorded for unit tests, or on devices running a version earlier than iOS 17. # Records videos of the iOS device screen, one per UI test case. + "discardOnPass": True or False, # Optional. Whether to discard the video of a test case when it passes. If not specified, the default is `false` (videos of all test cases are kept). }, "iosSwitchLocale": { # Switches the locale (language and region) of the iOS application. # Switches the locale (language and region) of the iOS application. "localeCode": "A String", # Required. The locale (language and region) to switch the app to. The format is `language-region` or `language`, e.g. "en-US", "zh-CN", "ja", etc. @@ -1172,6 +1205,9 @@Method Details
"cause": { # Describes the cause of the non-passed result occurred during the execution. # Output only. Detailed result cause diagnostics. Set if type is not PASSED. "summary": { # Describes the summary of an issue (error or warning) with structured details. # Output only. Structured cause detail. "message": "A String", # Output only. Human-readable explanation of the issue in English. + "metadata": { # Output only. Additional metadata about the issue. + "a_key": "A String", + }, "reason": "A String", # Output only. The reason of the issue. This is a constant value that identifies the proximate cause of the issue. This should be at most 63 characters and match a regular expression of `A-Z*[A-Z0-9]`, which represents UPPER_SNAKE_CASE. "type": "A String", # Output only. The issue classification based on responsibility. }, @@ -1189,6 +1225,9 @@Method Details
{ # Non-fatal operational anomaly, lint observation, or execution insight. "summary": { # Describes the summary of an issue (error or warning) with structured details. # Output only. Detailed warning summary. "message": "A String", # Output only. Human-readable explanation of the issue in English. + "metadata": { # Output only. Additional metadata about the issue. + "a_key": "A String", + }, "reason": "A String", # Output only. The reason of the issue. This is a constant value that identifies the proximate cause of the issue. This should be at most 63 characters and match a regular expression of `A-Z*[A-Z0-9]`, which represents UPPER_SNAKE_CASE. "type": "A String", # Output only. The issue classification based on responsibility. }, @@ -1211,6 +1250,9 @@Method Details
"cause": { # Describes the cause of the non-passed result occurred during the execution. # Output only. Detailed result cause diagnostics. Set if type is not PASSED. "summary": { # Describes the summary of an issue (error or warning) with structured details. # Output only. Structured cause detail. "message": "A String", # Output only. Human-readable explanation of the issue in English. + "metadata": { # Output only. Additional metadata about the issue. + "a_key": "A String", + }, "reason": "A String", # Output only. The reason of the issue. This is a constant value that identifies the proximate cause of the issue. This should be at most 63 characters and match a regular expression of `A-Z*[A-Z0-9]`, which represents UPPER_SNAKE_CASE. "type": "A String", # Output only. The issue classification based on responsibility. }, @@ -1228,6 +1270,9 @@Method Details
{ # Non-fatal operational anomaly, lint observation, or execution insight. "summary": { # Describes the summary of an issue (error or warning) with structured details. # Output only. Detailed warning summary. "message": "A String", # Output only. Human-readable explanation of the issue in English. + "metadata": { # Output only. Additional metadata about the issue. + "a_key": "A String", + }, "reason": "A String", # Output only. The reason of the issue. This is a constant value that identifies the proximate cause of the issue. This should be at most 63 characters and match a regular expression of `A-Z*[A-Z0-9]`, which represents UPPER_SNAKE_CASE. "type": "A String", # Output only. The issue classification based on responsibility. }, @@ -1239,6 +1284,9 @@Method Details
"cause": { # Describes the cause of the non-passed result occurred during the execution. # Output only. Detailed result cause diagnostics. Set if type is not PASSED. "summary": { # Describes the summary of an issue (error or warning) with structured details. # Output only. Structured cause detail. "message": "A String", # Output only. Human-readable explanation of the issue in English. + "metadata": { # Output only. Additional metadata about the issue. + "a_key": "A String", + }, "reason": "A String", # Output only. The reason of the issue. This is a constant value that identifies the proximate cause of the issue. This should be at most 63 characters and match a regular expression of `A-Z*[A-Z0-9]`, which represents UPPER_SNAKE_CASE. "type": "A String", # Output only. The issue classification based on responsibility. }, @@ -1266,11 +1314,11 @@Method Details
orderBy: string, Optional. The order to sort results by. Supported values: `name`, `name desc`, `create_time`, `create_time desc`. Values must use the snake_case field name; `createTime` is not accepted. Ordering by `create_time` is not supported when listing across all locations (`locations/-`). If unspecified, results are returned in an unspecified order. pageSize: integer, Optional. The maximum number of sessions to return. The server may return fewer items than this value. If unspecified, at most 500 sessions will be returned. The maximum value is 1000, values above will be coerced to 1000. pageToken: string, Optional. A page token, received from a previous `ListSessions` call. Provide this to receive the subsequent page. When paginating, all other parameters provided to `ListSessions` must match the call that provided the page token. - view: string, Optional. The view of the sessions to return. If not set, the `BASIC` view will be returned. + view: string, Optional. The view of the sessions to return. If not set, the `FULL` view will be returned. Allowed values - SESSION_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view. - SESSION_VIEW_BASIC - Include basic view of the session but not the full contents. Only the uid/display_name/status/result of the session and its jobs/executions will be included. This is the default value (for GetSession). - SESSION_VIEW_FULL - Include everything. + SESSION_VIEW_UNSPECIFIED - The default / unset value. The API will default to the FULL view. + SESSION_VIEW_BASIC - Include basic view of the session but not the full contents. Only the uid/display_name/status/result of the session and its jobs/executions will be included. + SESSION_VIEW_FULL - Include everything. This is the default value. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1283,6 +1331,7 @@Method Details
"nextPageToken": "A String", # Token to receive the next page of sessions. This will be absent if the end of the response list has been reached. "sessions": [ # The list of sessions. { # A session resource in the AutomationSession API. At a high level, `Session` describes the configuration of one or multiple jobs, the state transitions it goes through, and the results. + "createTime": "A String", # Output only. The time when the session was created. "name": "A String", # Identifier. The resource name of the session. Format: `projects/{project}/locations/{location}/sessions/{session}`. "sessionConfig": { # SessionConfig is used to create a session. # Required. Configuration used to create the session. "displayName": "A String", # Optional. User-settable, human-readable name for the session. Maximum size is 63 bytes when encoded as UTF-8. If set, must match regex: `^A-Za-z0-9*$`. @@ -1357,10 +1406,10 @@Method Details
"actions": [ # Optional. The actions to be performed on the device. Actions will be executed in the order they are specified in the list. Each action type can at most have 1 instance in the list. { # The action to be performed on a device. "androidBugreport": { # Captures a bugreport from the device. The output will be written to a file named `bugreport.zip` in the execution output directory. # Captures a bugreport from the device unless the test result is pass. - "collectOnPass": True or False, # Optional. Whether to deliver the bugreport when the test passes. If false, the bugreport is skipped on pass to save time (default behavior). If true, the bugreport is always delivered. + "collectOnPass": True or False, # Optional. Whether to deliver the bugreport when the test passes. If `false`, the bugreport is skipped on pass to save time (default behavior). If `true`, the bugreport is always delivered. }, "androidDumpsys": { # Captures dumpsys output from the device. The output will be written to a file named `dumpsys.log` in the execution output directory. # Captures a dumpsys from the device. - "collectOnPass": True or False, # Optional. Whether to deliver the dumpsys when the test passes. If false, the dumpsys is skipped on pass to save time (default behavior). If true, the dumpsys is always delivered. + "collectOnPass": True or False, # Optional. Whether to deliver the dumpsys when the test passes. If `false`, the dumpsys is skipped on pass to save time (default behavior). If `true`, the dumpsys is always delivered. }, "androidInstallPackages": { # Installs Android packages on the device. At least one installable is specified when using this device action. Limits: - A maximum of 20 installables in total are allowed. - A maximum of 100 files are allowed in total across all installables. # Installs Android packages on the device. "installables": [ # Optional. Deprecated: use `pre_target_app_installables`, `target_app` and `post_target_app_installables` instead. The Android packages to install on the device. The installation will be performed in the order specified, before the installables of all other fields. @@ -1435,7 +1484,7 @@Method Details
], }, "androidRecordVideo": { # Records a video of the device screen during the run. The video will be written to a file named `video.mp4` in the execution output directory. # Records a video of the device screen during the run. - "discardOnPass": True or False, # Optional. Whether to discard and not upload the recording when the test passes. Default is false. + "discardOnPass": True or False, # Optional. Whether to discard and not upload the recording when the test passes. Default is `false`. }, "androidSwitchLocale": { # Switches the locale (language and region) of the device. # Switches the locale (language and region) of the device. "localeCode": "A String", # Required. The locale (language and region) to switch the device to. The format is `language-region`, e.g. "en-US", "zh-CN", etc. The typical language value is a two or three-letter language code as defined in ISO639. The typical region value is a two-letter ISO 3166 code or a three-digit UN M.49 area code. @@ -1472,8 +1521,8 @@Method Details
}, ], }, - "iosRecordVideo": { # Records a video of the iOS device screen during the run. The video will be written to a file named `video.mp4` in the execution output directory. # Records a video of the iOS device screen during the run. - "discardOnPass": True or False, # Optional. Whether to discard the video if the test passes. If not specified, the default is false (always keep the video). + "iosRecordVideo": { # Records videos of the iOS device screen, one per UI test case. Each video covers only the execution of its test case, and will be written to `testcases/{test_class}/{test_method}/video.mp4` in the execution output directory. No video is recorded for unit tests, or on devices running a version earlier than iOS 17. # Records videos of the iOS device screen, one per UI test case. + "discardOnPass": True or False, # Optional. Whether to discard the video of a test case when it passes. If not specified, the default is `false` (videos of all test cases are kept). }, "iosSwitchLocale": { # Switches the locale (language and region) of the iOS application. # Switches the locale (language and region) of the iOS application. "localeCode": "A String", # Required. The locale (language and region) to switch the app to. The format is `language-region` or `language`, e.g. "en-US", "zh-CN", "ja", etc. @@ -1536,6 +1585,9 @@Method Details
"cause": { # Describes the cause of the non-passed result occurred during the execution. # Output only. Detailed result cause diagnostics. Set if type is not PASSED. "summary": { # Describes the summary of an issue (error or warning) with structured details. # Output only. Structured cause detail. "message": "A String", # Output only. Human-readable explanation of the issue in English. + "metadata": { # Output only. Additional metadata about the issue. + "a_key": "A String", + }, "reason": "A String", # Output only. The reason of the issue. This is a constant value that identifies the proximate cause of the issue. This should be at most 63 characters and match a regular expression of `A-Z*[A-Z0-9]`, which represents UPPER_SNAKE_CASE. "type": "A String", # Output only. The issue classification based on responsibility. }, @@ -1553,6 +1605,9 @@Method Details
{ # Non-fatal operational anomaly, lint observation, or execution insight. "summary": { # Describes the summary of an issue (error or warning) with structured details. # Output only. Detailed warning summary. "message": "A String", # Output only. Human-readable explanation of the issue in English. + "metadata": { # Output only. Additional metadata about the issue. + "a_key": "A String", + }, "reason": "A String", # Output only. The reason of the issue. This is a constant value that identifies the proximate cause of the issue. This should be at most 63 characters and match a regular expression of `A-Z*[A-Z0-9]`, which represents UPPER_SNAKE_CASE. "type": "A String", # Output only. The issue classification based on responsibility. }, @@ -1575,6 +1630,9 @@Method Details
"cause": { # Describes the cause of the non-passed result occurred during the execution. # Output only. Detailed result cause diagnostics. Set if type is not PASSED. "summary": { # Describes the summary of an issue (error or warning) with structured details. # Output only. Structured cause detail. "message": "A String", # Output only. Human-readable explanation of the issue in English. + "metadata": { # Output only. Additional metadata about the issue. + "a_key": "A String", + }, "reason": "A String", # Output only. The reason of the issue. This is a constant value that identifies the proximate cause of the issue. This should be at most 63 characters and match a regular expression of `A-Z*[A-Z0-9]`, which represents UPPER_SNAKE_CASE. "type": "A String", # Output only. The issue classification based on responsibility. }, @@ -1592,6 +1650,9 @@Method Details
{ # Non-fatal operational anomaly, lint observation, or execution insight. "summary": { # Describes the summary of an issue (error or warning) with structured details. # Output only. Detailed warning summary. "message": "A String", # Output only. Human-readable explanation of the issue in English. + "metadata": { # Output only. Additional metadata about the issue. + "a_key": "A String", + }, "reason": "A String", # Output only. The reason of the issue. This is a constant value that identifies the proximate cause of the issue. This should be at most 63 characters and match a regular expression of `A-Z*[A-Z0-9]`, which represents UPPER_SNAKE_CASE. "type": "A String", # Output only. The issue classification based on responsibility. }, @@ -1603,6 +1664,9 @@Method Details
"cause": { # Describes the cause of the non-passed result occurred during the execution. # Output only. Detailed result cause diagnostics. Set if type is not PASSED. "summary": { # Describes the summary of an issue (error or warning) with structured details. # Output only. Structured cause detail. "message": "A String", # Output only. Human-readable explanation of the issue in English. + "metadata": { # Output only. Additional metadata about the issue. + "a_key": "A String", + }, "reason": "A String", # Output only. The reason of the issue. This is a constant value that identifies the proximate cause of the issue. This should be at most 63 characters and match a regular expression of `A-Z*[A-Z0-9]`, which represents UPPER_SNAKE_CASE. "type": "A String", # Output only. The issue classification based on responsibility. }, diff --git a/docs/dyn/dialogflow_v2.projects.agent.environments.users.sessions.html b/docs/dyn/dialogflow_v2.projects.agent.environments.users.sessions.html index 06800080c8..893cb25ce1 100644 --- a/docs/dyn/dialogflow_v2.projects.agent.environments.users.sessions.html +++ b/docs/dyn/dialogflow_v2.projects.agent.environments.users.sessions.html @@ -155,13 +155,13 @@Method Details
"queryInput": { "audioConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "disableNoSpeechRecognizedEvent": True or False, "enableAutomaticPunctuation": True or False, "enableVoiceActivityEvents": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", diff --git a/docs/dyn/dialogflow_v2.projects.agent.sessions.html b/docs/dyn/dialogflow_v2.projects.agent.sessions.html index d41ab5b2b7..72e4bdb8e1 100644 --- a/docs/dyn/dialogflow_v2.projects.agent.sessions.html +++ b/docs/dyn/dialogflow_v2.projects.agent.sessions.html @@ -155,13 +155,13 @@Method Details
"queryInput": { "audioConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "disableNoSpeechRecognizedEvent": True or False, "enableAutomaticPunctuation": True or False, "enableVoiceActivityEvents": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", diff --git a/docs/dyn/dialogflow_v2.projects.conversationProfiles.html b/docs/dyn/dialogflow_v2.projects.conversationProfiles.html index fea3ccf2c7..97b77a0198 100644 --- a/docs/dyn/dialogflow_v2.projects.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2.projects.conversationProfiles.html @@ -371,10 +371,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -632,10 +632,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -918,10 +918,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -1190,10 +1190,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -1470,10 +1470,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -1732,10 +1732,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", diff --git a/docs/dyn/dialogflow_v2.projects.conversations.html b/docs/dyn/dialogflow_v2.projects.conversations.html index 31426a57b2..3f9dc020c5 100644 --- a/docs/dyn/dialogflow_v2.projects.conversations.html +++ b/docs/dyn/dialogflow_v2.projects.conversations.html @@ -364,10 +364,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -675,10 +675,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -985,10 +985,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -1301,10 +1301,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -1622,10 +1622,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", diff --git a/docs/dyn/dialogflow_v2.projects.conversations.participants.html b/docs/dyn/dialogflow_v2.projects.conversations.participants.html index 888968dd2d..d801b26022 100644 --- a/docs/dyn/dialogflow_v2.projects.conversations.participants.html +++ b/docs/dyn/dialogflow_v2.projects.conversations.participants.html @@ -120,13 +120,13 @@Method Details
"audio": "A String", "config": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "disableNoSpeechRecognizedEvent": True or False, "enableAutomaticPunctuation": True or False, "enableVoiceActivityEvents": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", diff --git a/docs/dyn/dialogflow_v2.projects.locations.agent.environments.users.sessions.html b/docs/dyn/dialogflow_v2.projects.locations.agent.environments.users.sessions.html index 76da68d446..adbac5f2a8 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.agent.environments.users.sessions.html +++ b/docs/dyn/dialogflow_v2.projects.locations.agent.environments.users.sessions.html @@ -155,13 +155,13 @@Method Details
"queryInput": { "audioConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "disableNoSpeechRecognizedEvent": True or False, "enableAutomaticPunctuation": True or False, "enableVoiceActivityEvents": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", diff --git a/docs/dyn/dialogflow_v2.projects.locations.agent.sessions.html b/docs/dyn/dialogflow_v2.projects.locations.agent.sessions.html index 91b91ad892..58b8f9d354 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.agent.sessions.html +++ b/docs/dyn/dialogflow_v2.projects.locations.agent.sessions.html @@ -155,13 +155,13 @@Method Details
"queryInput": { "audioConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "disableNoSpeechRecognizedEvent": True or False, "enableAutomaticPunctuation": True or False, "enableVoiceActivityEvents": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html b/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html index aa7a4c3600..224b5ead0c 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html @@ -371,10 +371,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -632,10 +632,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -918,10 +918,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -1190,10 +1190,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -1470,10 +1470,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -1732,10 +1732,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.html index fb35ed4358..36f4d5099b 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversations.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.html @@ -367,10 +367,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -678,10 +678,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -988,10 +988,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -1304,10 +1304,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -1679,10 +1679,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html index e327d2c1de..d539920bf0 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html @@ -120,13 +120,13 @@Method Details
"audio": "A String", "config": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "disableNoSpeechRecognizedEvent": True or False, "enableAutomaticPunctuation": True or False, "enableVoiceActivityEvents": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", diff --git a/docs/dyn/dialogflow_v2.projects.locations.suggestions.html b/docs/dyn/dialogflow_v2.projects.locations.suggestions.html index 2171f31e4d..ef89c8ef40 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.locations.suggestions.html @@ -311,10 +311,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", diff --git a/docs/dyn/dialogflow_v2.projects.suggestions.html b/docs/dyn/dialogflow_v2.projects.suggestions.html index 1737af8b1e..11ddb288ac 100644 --- a/docs/dyn/dialogflow_v2.projects.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.suggestions.html @@ -311,10 +311,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", diff --git a/docs/dyn/dialogflow_v2beta1.projects.agent.environments.users.sessions.html b/docs/dyn/dialogflow_v2beta1.projects.agent.environments.users.sessions.html index fa52cac0bb..25c734c9fd 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.agent.environments.users.sessions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.agent.environments.users.sessions.html @@ -160,13 +160,13 @@Method Details
"totalDuration": "A String", }, "defaultNoSpeechTimeout": "A String", + "disableInterimInputTranscripts": True or False, "disableNoSpeechRecognizedEvent": True or False, "enableAutomaticPunctuation": True or False, "enableVoiceActivityEvents": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", diff --git a/docs/dyn/dialogflow_v2beta1.projects.agent.sessions.html b/docs/dyn/dialogflow_v2beta1.projects.agent.sessions.html index 5c00932d6a..7d087b20a2 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.agent.sessions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.agent.sessions.html @@ -160,13 +160,13 @@Method Details
"totalDuration": "A String", }, "defaultNoSpeechTimeout": "A String", + "disableInterimInputTranscripts": True or False, "disableNoSpeechRecognizedEvent": True or False, "enableAutomaticPunctuation": True or False, "enableVoiceActivityEvents": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html b/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html index 5a3a1b76d0..16cd111a48 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html @@ -363,10 +363,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -617,10 +617,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -896,10 +896,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -1161,10 +1161,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -1434,10 +1434,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -1689,10 +1689,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.html index abad93b863..f7fb1f1c7f 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.html @@ -356,10 +356,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -660,10 +660,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -963,10 +963,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -1272,10 +1272,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -1586,10 +1586,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html index b524e0e111..14e4f299d4 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html @@ -125,13 +125,13 @@Method Details
"totalDuration": "A String", }, "defaultNoSpeechTimeout": "A String", + "disableInterimInputTranscripts": True or False, "disableNoSpeechRecognizedEvent": True or False, "enableAutomaticPunctuation": True or False, "enableVoiceActivityEvents": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.environments.users.sessions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.environments.users.sessions.html index 0d58d7986d..fd5b1d5cf7 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.environments.users.sessions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.environments.users.sessions.html @@ -160,13 +160,13 @@Method Details
"totalDuration": "A String", }, "defaultNoSpeechTimeout": "A String", + "disableInterimInputTranscripts": True or False, "disableNoSpeechRecognizedEvent": True or False, "enableAutomaticPunctuation": True or False, "enableVoiceActivityEvents": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.sessions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.sessions.html index 6f79463a61..2538ee6cd8 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.sessions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.sessions.html @@ -160,13 +160,13 @@Method Details
"totalDuration": "A String", }, "defaultNoSpeechTimeout": "A String", + "disableInterimInputTranscripts": True or False, "disableNoSpeechRecognizedEvent": True or False, "enableAutomaticPunctuation": True or False, "enableVoiceActivityEvents": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html index e724cc4624..d498c84499 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html @@ -363,10 +363,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -617,10 +617,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -896,10 +896,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -1161,10 +1161,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -1434,10 +1434,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -1689,10 +1689,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.html index c187f81770..16d5fa4106 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.html @@ -359,10 +359,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -663,10 +663,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -966,10 +966,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -1275,10 +1275,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", @@ -1643,10 +1643,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html index 4ae69fc567..e1193a4995 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html @@ -125,13 +125,13 @@Method Details
"totalDuration": "A String", }, "defaultNoSpeechTimeout": "A String", + "disableInterimInputTranscripts": True or False, "disableNoSpeechRecognizedEvent": True or False, "enableAutomaticPunctuation": True or False, "enableVoiceActivityEvents": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html index 393f859a89..91df8467c8 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html @@ -303,10 +303,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", diff --git a/docs/dyn/dialogflow_v2beta1.projects.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.suggestions.html index a8375c1e7d..749af48452 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.suggestions.html @@ -303,10 +303,10 @@Method Details
}, "sttConfig": { "audioEncoding": "A String", + "disableInterimInputTranscripts": True or False, "enableWordInfo": True or False, "geminiAsrConfig": { "endOfSpeechSensitivity": "A String", - "modelId": "A String", "prefixPaddingMs": 42, "silenceDurationMs": 42, "startOfSpeechSensitivity": "A String", diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html index 1f4b1dbfa3..26488a8b3e 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html @@ -355,6 +355,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -605,6 +608,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -846,6 +852,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -1040,6 +1049,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -1216,6 +1228,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html index d33db79dc1..52c66ba19d 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html @@ -1454,7 +1454,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -1706,7 +1708,7 @@Method Details
"A String", ], }, - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. @@ -2206,7 +2208,7 @@Method Details
"A String", ], }, - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html index e25b9cf203..1fcdb79d71 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html @@ -204,7 +204,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -432,7 +434,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -585,7 +589,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. 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 ad243504c1..9fef14042f 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.widgetConfigs.html @@ -336,7 +336,7 @@Method Details
"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -626,7 +626,7 @@Method Details
"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -915,7 +915,7 @@Method Details
"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html index 0eeb9254c5..5a76697bf1 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html @@ -204,7 +204,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -397,7 +397,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -566,7 +566,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -707,7 +707,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -830,7 +830,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html index 356ed95ee4..1c207e8363 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html @@ -1454,7 +1454,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -1706,7 +1708,7 @@Method Details
"A String", ], }, - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. @@ -2206,7 +2208,7 @@Method Details
"A String", ], }, - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. 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 92fd7411dd..7b22b083c6 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.widgetConfigs.html @@ -336,7 +336,7 @@Method Details
"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -626,7 +626,7 @@Method Details
"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -915,7 +915,7 @@Method Details
"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html index 2eebd1ace1..14277d0ba1 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html @@ -347,6 +347,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -597,6 +600,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -838,6 +844,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -1032,6 +1041,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -1208,6 +1220,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html index 1407eb2f6e..3ec5022ae8 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html @@ -1454,7 +1454,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -1706,7 +1708,7 @@Method Details
"A String", ], }, - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. @@ -2206,7 +2208,7 @@Method Details
"A String", ], }, - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html index 2f2aed06f4..89865e0e81 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html @@ -204,7 +204,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -432,7 +434,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -585,7 +589,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.widgetConfigs.html index 60114178d0..e0546111ab 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.widgetConfigs.html @@ -336,7 +336,7 @@Method Details
"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -626,7 +626,7 @@Method Details
"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -915,7 +915,7 @@Method Details
"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html b/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html index 39ddb5c1e3..60b916f4a5 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html @@ -201,7 +201,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -386,7 +388,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -539,7 +543,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.authorizations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.authorizations.html index e94701714b..6cf0063dc7 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.authorizations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.authorizations.html @@ -119,6 +119,9 @@Method Details
"clientId": "A String", # Required. The OAuth2 client ID. "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest. "pkceVerificationEnabled": True or False, # Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/ + "privateNetworkConfig": { # Identifies the instance hosting an OAuth provider that is reachable only over a private network. # Optional. Set only when the OAuth provider publishes no public endpoint, in which case a token exchange has to be routed over the private network the instance is on instead of over public egress. Leaving it unset keeps the exchange on public egress. + "instanceResource": "A String", # Required. Resource name of the instance hosting the OAuth provider. For Looker, the Looker instance, in the form `projects/{project}/locations/{location}/instances/{instance}`. + }, "scopes": [ # Optional. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` If omitted, no additional scopes are requested beyond those required by the authorization uri. If set, it will overwrite the scopes in the authorization uri when acquiring user authorization. "A String", ], @@ -144,6 +147,9 @@Method Details
"clientId": "A String", # Required. The OAuth2 client ID. "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest. "pkceVerificationEnabled": True or False, # Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/ + "privateNetworkConfig": { # Identifies the instance hosting an OAuth provider that is reachable only over a private network. # Optional. Set only when the OAuth provider publishes no public endpoint, in which case a token exchange has to be routed over the private network the instance is on instead of over public egress. Leaving it unset keeps the exchange on public egress. + "instanceResource": "A String", # Required. Resource name of the instance hosting the OAuth provider. For Looker, the Looker instance, in the form `projects/{project}/locations/{location}/instances/{instance}`. + }, "scopes": [ # Optional. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` If omitted, no additional scopes are requested beyond those required by the authorization uri. If set, it will overwrite the scopes in the authorization uri when acquiring user authorization. "A String", ], @@ -193,6 +199,9 @@Method Details
"clientId": "A String", # Required. The OAuth2 client ID. "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest. "pkceVerificationEnabled": True or False, # Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/ + "privateNetworkConfig": { # Identifies the instance hosting an OAuth provider that is reachable only over a private network. # Optional. Set only when the OAuth provider publishes no public endpoint, in which case a token exchange has to be routed over the private network the instance is on instead of over public egress. Leaving it unset keeps the exchange on public egress. + "instanceResource": "A String", # Required. Resource name of the instance hosting the OAuth provider. For Looker, the Looker instance, in the form `projects/{project}/locations/{location}/instances/{instance}`. + }, "scopes": [ # Optional. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` If omitted, no additional scopes are requested beyond those required by the authorization uri. If set, it will overwrite the scopes in the authorization uri when acquiring user authorization. "A String", ], @@ -228,6 +237,9 @@Method Details
"clientId": "A String", # Required. The OAuth2 client ID. "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest. "pkceVerificationEnabled": True or False, # Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/ + "privateNetworkConfig": { # Identifies the instance hosting an OAuth provider that is reachable only over a private network. # Optional. Set only when the OAuth provider publishes no public endpoint, in which case a token exchange has to be routed over the private network the instance is on instead of over public egress. Leaving it unset keeps the exchange on public egress. + "instanceResource": "A String", # Required. Resource name of the instance hosting the OAuth provider. For Looker, the Looker instance, in the form `projects/{project}/locations/{location}/instances/{instance}`. + }, "scopes": [ # Optional. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` If omitted, no additional scopes are requested beyond those required by the authorization uri. If set, it will overwrite the scopes in the authorization uri when acquiring user authorization. "A String", ], @@ -271,6 +283,9 @@Method Details
"clientId": "A String", # Required. The OAuth2 client ID. "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest. "pkceVerificationEnabled": True or False, # Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/ + "privateNetworkConfig": { # Identifies the instance hosting an OAuth provider that is reachable only over a private network. # Optional. Set only when the OAuth provider publishes no public endpoint, in which case a token exchange has to be routed over the private network the instance is on instead of over public egress. Leaving it unset keeps the exchange on public egress. + "instanceResource": "A String", # Required. Resource name of the instance hosting the OAuth provider. For Looker, the Looker instance, in the form `projects/{project}/locations/{location}/instances/{instance}`. + }, "scopes": [ # Optional. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` If omitted, no additional scopes are requested beyond those required by the authorization uri. If set, it will overwrite the scopes in the authorization uri when acquiring user authorization. "A String", ], @@ -296,6 +311,9 @@Method Details
"clientId": "A String", # Required. The OAuth2 client ID. "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest. "pkceVerificationEnabled": True or False, # Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/ + "privateNetworkConfig": { # Identifies the instance hosting an OAuth provider that is reachable only over a private network. # Optional. Set only when the OAuth provider publishes no public endpoint, in which case a token exchange has to be routed over the private network the instance is on instead of over public egress. Leaving it unset keeps the exchange on public egress. + "instanceResource": "A String", # Required. Resource name of the instance hosting the OAuth provider. For Looker, the Looker instance, in the form `projects/{project}/locations/{location}/instances/{instance}`. + }, "scopes": [ # Optional. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` If omitted, no additional scopes are requested beyond those required by the authorization uri. If set, it will overwrite the scopes in the authorization uri when acquiring user authorization. "A String", ], diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html index c40072558f..ae49e025a7 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html @@ -424,6 +424,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -478,6 +481,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished @@ -755,6 +760,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -809,6 +817,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished @@ -1146,6 +1156,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -1200,6 +1213,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished @@ -1374,6 +1389,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -1428,6 +1446,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished @@ -1584,6 +1604,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -1638,6 +1661,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.schemas.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.schemas.html index 90043545f4..33e459e199 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.schemas.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.schemas.html @@ -128,6 +128,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished @@ -236,6 +238,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished @@ -285,6 +289,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished @@ -340,6 +346,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html index ec00527f70..3df72b0cf1 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html @@ -1714,7 +1714,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -1972,7 +1974,7 @@Method Details
"A String", ], }, - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. @@ -2658,7 +2660,7 @@Method Details
"A String", ], }, - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html index 7f4f9b425f..3f8efcd021 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html @@ -241,7 +241,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -506,7 +508,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -696,7 +700,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. 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 56a7d504e1..039ed3d52b 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html @@ -341,7 +341,7 @@Method Details
"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -636,7 +636,7 @@Method Details
"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -930,7 +930,7 @@Method Details
"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.agents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.agents.html index 87e7cfd28b..b7a136cb07 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.agents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.agents.html @@ -84,11 +84,6 @@Instance Methods
Returns the operations Resource.
--
-toolCalls()-Returns the toolCalls Resource.
-Close httplib2 connections.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html index 021875c790..edba8d626c 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html @@ -84,11 +84,6 @@Instance Methods
Returns the assistants Resource.
- -Returns the collaborativeProjects Resource.
- @@ -232,7 +227,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -434,7 +429,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -660,7 +655,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -810,7 +805,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -942,7 +937,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -1086,7 +1081,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -1230,7 +1225,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html index 2651c81505..8c7cfbc562 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html @@ -1714,7 +1714,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -1972,7 +1974,7 @@Method Details
"A String", ], }, - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. @@ -2658,7 +2660,7 @@Method Details
"A String", ], }, - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. 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 94b301326a..009cf6a828 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html @@ -341,7 +341,7 @@Method Details
"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -636,7 +636,7 @@Method Details
"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -930,7 +930,7 @@Method Details
"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html index 32d4f81e84..654aae7962 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html @@ -321,6 +321,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished @@ -602,6 +604,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished @@ -922,6 +926,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished @@ -1217,6 +1223,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished @@ -1580,6 +1588,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished @@ -1852,6 +1862,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html index 700722016c..e0fae4e9d4 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html @@ -416,6 +416,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -470,6 +473,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished @@ -747,6 +752,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -801,6 +809,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished @@ -1138,6 +1148,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -1192,6 +1205,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished @@ -1366,6 +1381,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -1420,6 +1438,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished @@ -1576,6 +1596,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -1630,6 +1653,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.schemas.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.schemas.html index 6cfc352bae..f73b84e7f5 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.schemas.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.schemas.html @@ -123,6 +123,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished @@ -231,6 +233,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished @@ -280,6 +284,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished @@ -335,6 +341,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html index c6745db009..a63a8a7df3 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html @@ -1714,7 +1714,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -1972,7 +1974,7 @@Method Details
"A String", ], }, - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. @@ -2658,7 +2660,7 @@Method Details
"A String", ], }, - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html index c4ce56645d..3b43f8a839 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html @@ -241,7 +241,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -506,7 +508,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -696,7 +700,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html index f10fb4fe36..d8dddc88c6 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html @@ -341,7 +341,7 @@Method Details
"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -636,7 +636,7 @@Method Details
"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -930,7 +930,7 @@Method Details
"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html index 47e68c3ad9..ee0078f6ec 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html @@ -217,7 +217,7 @@Method Details
"A String", ], }, - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. @@ -566,7 +566,7 @@Method Details
"A String", ], }, - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. @@ -891,7 +891,7 @@Method Details
"A String", ], }, - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.html index 11cc2796c5..d663a0b300 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.html @@ -109,6 +109,11 @@Instance Methods
Returns the identityMappingStores Resource.
+ +Returns the knowledgeSpaces Resource.
+ @@ -1233,6 +1238,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished @@ -1535,6 +1542,8 @@Method Details
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + "partialMatchableOption": "A String", # Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. + "prefixMatchableOption": "A String", # Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.knowledgeSpaces.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.knowledgeSpaces.html new file mode 100644 index 0000000000..cd76fc5126 --- /dev/null +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.knowledgeSpaces.html @@ -0,0 +1,91 @@ + + + +Discovery Engine API . projects . locations . knowledgeSpaces
+Instance Methods
++
+operations()+Returns the operations Resource.
+ ++
+close()Close httplib2 connections.
+Method Details
+++ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.knowledgeSpaces.operations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.knowledgeSpaces.operations.html new file mode 100644 index 0000000000..6ecea68e22 --- /dev/null +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.knowledgeSpaces.operations.html @@ -0,0 +1,124 @@ + + + +close()+Close httplib2 connections.+Discovery Engine API . projects . locations . knowledgeSpaces . operations
+Instance Methods
++
+close()Close httplib2 connections.
+ +Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+Method Details
+++ +close()+Close httplib2 connections.+++ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.userEvents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.userEvents.html index 7174a0a254..38deff94b2 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.userEvents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.userEvents.html @@ -238,7 +238,9 @@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. + }, +}+Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -460,7 +462,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -650,7 +654,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html index fd4787fa29..47016ad55f 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html @@ -350,6 +350,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -606,6 +609,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -853,6 +859,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -1053,6 +1062,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -1235,6 +1247,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html index 679380e9c2..775c32a68b 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html @@ -1551,7 +1551,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -1806,7 +1808,7 @@Method Details
"A String", ], }, - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. @@ -2488,7 +2490,7 @@Method Details
"A String", ], }, - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html index 30752db899..9bc474b4bf 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html @@ -204,7 +204,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -432,7 +434,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -585,7 +589,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html index f6f8ce3d11..32bed9edbf 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html @@ -208,7 +208,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -401,7 +401,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -570,7 +570,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -711,7 +711,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -834,7 +834,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -969,7 +969,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -1104,7 +1104,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html index 93339632c8..253a8754c2 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html @@ -1551,7 +1551,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -1806,7 +1808,7 @@Method Details
"A String", ], }, - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. @@ -2488,7 +2490,7 @@Method Details
"A String", ], }, - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html index 0e77add2a4..8a7b25255f 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html @@ -342,6 +342,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -598,6 +601,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -845,6 +851,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -1045,6 +1054,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. @@ -1227,6 +1239,9 @@Method Details
], }, "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "notebooks": [ # Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. + "A String", + ], "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* }, "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html index ef12908aaf..e2d7d8020a 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html @@ -1551,7 +1551,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -1806,7 +1808,7 @@Method Details
"A String", ], }, - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. @@ -2488,7 +2490,7 @@Method Details
"A String", ], }, - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html index 2ffe557538..b1162b7215 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html @@ -204,7 +204,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -432,7 +434,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -585,7 +589,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html index 53000c2dbc..589d08262a 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html @@ -214,7 +214,7 @@Method Details
"A String", ], }, - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. @@ -559,7 +559,7 @@Method Details
"A String", ], }, - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. @@ -880,7 +880,7 @@Method Details
"A String", ], }, - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.userEvents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.userEvents.html index b858947e56..3ac3bd5794 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.userEvents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.userEvents.html @@ -201,7 +201,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -386,7 +388,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. @@ -539,7 +543,9 @@Method Details
}, "questionIndex": 42, # The index of the user input within the conversation messages. "session": "A String", # Name of the newly generated or continued session. - "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} + "stepSeqNum": "A String", # Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. + "taskName": "A String", # Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} + "trajectoryId": "A String", # Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. }, "dataTermsAccepted": True or False, # Optional. Whether the customer accepted data use terms. "feedbackSource": "A String", # Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. diff --git a/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html index 83b4d36a35..32a1932ccd 100644 --- a/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html @@ -129,7 +129,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -779,7 +778,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -850,7 +848,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -1208,7 +1205,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). diff --git a/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html index 7674b681f6..89b9fca25f 100644 --- a/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html @@ -128,7 +128,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -777,7 +776,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -847,7 +845,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -1204,7 +1201,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). diff --git a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroupAds.html b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroupAds.html index d1528f6935..de066ee480 100644 --- a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroupAds.html +++ b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroupAds.html @@ -120,7 +120,7 @@Method Details
"audioAd": { # Details for an audio ad. # Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives. "displayUrl": "A String", # The webpage address that appears with the ad. "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -129,7 +129,7 @@Method Details
}, "bumperAd": { # Details for a bumper ad. # Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -142,7 +142,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -157,7 +157,7 @@Method Details
"entityStatus": "A String", # The entity status of the ad. "inStreamAd": { # Details for an in-stream ad. # Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -170,7 +170,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -207,7 +207,7 @@Method Details
"name": "A String", # The resource name of the ad. "nonSkippableAd": { # Details for a non-skippable ad. # Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -220,7 +220,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -243,7 +243,7 @@Method Details
}, }, "videoPerformanceAd": { # Details for a video performance ad. # Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. - "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. + "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. Must be set if headlines is set. "A String", ], "companionBanners": [ # Optional. The list of companion banners used by this ad. @@ -260,20 +260,20 @@Method Details
"customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, - "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. + "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL. - "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. + "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. Can only be set if displayUrlBreadcrumb1 is also set. "domain": "A String", # Output only. The domain of the display URL. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "headlines": [ # Optional. The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. + "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "videos": [ # Required. The list of YouTube video assets used by this ad. { # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. @@ -319,7 +319,7 @@Method Details
"audioAd": { # Details for an audio ad. # Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives. "displayUrl": "A String", # The webpage address that appears with the ad. "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -328,7 +328,7 @@Method Details
}, "bumperAd": { # Details for a bumper ad. # Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -341,7 +341,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -356,7 +356,7 @@Method Details
"entityStatus": "A String", # The entity status of the ad. "inStreamAd": { # Details for an in-stream ad. # Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -369,7 +369,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -406,7 +406,7 @@Method Details
"name": "A String", # The resource name of the ad. "nonSkippableAd": { # Details for a non-skippable ad. # Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -419,7 +419,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -442,7 +442,7 @@Method Details
}, }, "videoPerformanceAd": { # Details for a video performance ad. # Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. - "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. + "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. Must be set if headlines is set. "A String", ], "companionBanners": [ # Optional. The list of companion banners used by this ad. @@ -459,20 +459,20 @@Method Details
"customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, - "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. + "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL. - "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. + "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. Can only be set if displayUrlBreadcrumb1 is also set. "domain": "A String", # Output only. The domain of the display URL. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "headlines": [ # Optional. The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. + "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "videos": [ # Required. The list of YouTube video assets used by this ad. { # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. diff --git a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html index 383468d329..94a76e54bb 100644 --- a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html @@ -123,7 +123,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -481,7 +480,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). diff --git a/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html index 6e6a199e0a..f50888afdc 100644 --- a/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html @@ -128,7 +128,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -777,7 +776,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -847,7 +845,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -1204,7 +1201,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). diff --git a/docs/dyn/displayvideo_v2.targetingTypes.targetingOptions.html b/docs/dyn/displayvideo_v2.targetingTypes.targetingOptions.html index 9203dc557d..2a2be0b5e7 100644 --- a/docs/dyn/displayvideo_v2.targetingTypes.targetingOptions.html +++ b/docs/dyn/displayvideo_v2.targetingTypes.targetingOptions.html @@ -127,7 +127,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -305,7 +304,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -505,7 +503,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html b/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html index 67947b9c22..6713547521 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html @@ -79,10 +79,10 @@Instance Methods
Close httplib2 connections.
-
create(advertiserId, body=None, x__xgafv=None)Creates an ad group ad. This method is only supported for Demand Gen ads.
+Creates an ad group ad.
-
delete(advertiserId, adGroupAdId, x__xgafv=None)Deletes an ad group ad. This method is only supported for Demand Gen ads.
+Deletes an ad group ad.
get(advertiserId, adGroupAdId, x__xgafv=None)Gets an ad group ad.
@@ -94,7 +94,7 @@Instance Methods
Retrieves the next page of results.
-
patch(advertiserId, adGroupAdId, body=None, updateMask=None, x__xgafv=None)Updates an ad group ad. This method is only supported for Demand Gen ads.
+Updates an ad group ad.
Method Details
close()@@ -103,14 +103,14 @@Method Details
diff --git a/docs/dyn/fcm_v1.projects.messages.html b/docs/dyn/fcm_v1.projects.messages.html index 28460efa43..7f1d012794 100644 --- a/docs/dyn/fcm_v1.projects.messages.html +++ b/docs/dyn/fcm_v1.projects.messages.html @@ -156,6 +156,69 @@create(advertiserId, body=None, x__xgafv=None)-Creates an ad group ad. This method is only supported for Demand Gen ads. +Creates an ad group ad. Args: advertiserId: string, Output only. The unique ID of the advertiser the ad belongs to. (required) body: object, The request body. The object takes the form of: -{ # LINT: LEGACY_NAMES A single ad associated with an ad group. +{ # A single ad associated with an ad group. "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. "adGroupId": "A String", # Required. Immutable. The unique ID of the ad group that the ad belongs to. "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. @@ -256,7 +256,7 @@Method Details
"audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives. "displayUrl": "A String", # The webpage address that appears with the ad. "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -265,7 +265,7 @@Method Details
}, "bumperAd": { # Details for a bumper ad. # Optional. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -278,7 +278,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -286,7 +286,7 @@Method Details
}, }, }, - "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. To remove the DCM tracking ad info, please leave this field empty. "creativeId": "A String", # Required. The DCM creative id. "placementId": "A String", # Required. The DCM placement id. "trackingAdId": "A String", # Required. The DCM tracking ad id. @@ -488,7 +488,7 @@Method Details
"entityStatus": "A String", # Required. The entity status of the ad. "inStreamAd": { # Details for an in-stream ad. # Optional. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -501,7 +501,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -538,7 +538,7 @@Method Details
"name": "A String", # Output only. The resource name of the ad. "nonSkippableAd": { # Details for a non-skippable ad. # Optional. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -551,7 +551,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -574,7 +574,7 @@Method Details
}, }, "videoPerformanceAd": { # Details for a video performance ad. # Optional. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. - "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. + "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. Must be set if headlines is set. "A String", ], "companionBanners": [ # Optional. The list of companion banners used by this ad. @@ -591,20 +591,20 @@Method Details
"customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, - "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. + "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL. - "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. + "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. Can only be set if displayUrlBreadcrumb1 is also set. "domain": "A String", # Output only. The domain of the display URL. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "headlines": [ # Optional. The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. + "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "videos": [ # Required. The list of YouTube video assets used by this ad. { # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. @@ -623,7 +623,7 @@Method Details
Returns: An object of the form: - { # LINT: LEGACY_NAMES A single ad associated with an ad group. + { # A single ad associated with an ad group. "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. "adGroupId": "A String", # Required. Immutable. The unique ID of the ad group that the ad belongs to. "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. @@ -769,7 +769,7 @@Method Details
"audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives. "displayUrl": "A String", # The webpage address that appears with the ad. "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -778,7 +778,7 @@Method Details
}, "bumperAd": { # Details for a bumper ad. # Optional. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -791,7 +791,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -799,7 +799,7 @@Method Details
}, }, }, - "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. To remove the DCM tracking ad info, please leave this field empty. "creativeId": "A String", # Required. The DCM creative id. "placementId": "A String", # Required. The DCM placement id. "trackingAdId": "A String", # Required. The DCM tracking ad id. @@ -1001,7 +1001,7 @@Method Details
"entityStatus": "A String", # Required. The entity status of the ad. "inStreamAd": { # Details for an in-stream ad. # Optional. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -1014,7 +1014,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -1051,7 +1051,7 @@Method Details
"name": "A String", # Output only. The resource name of the ad. "nonSkippableAd": { # Details for a non-skippable ad. # Optional. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -1064,7 +1064,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -1087,7 +1087,7 @@Method Details
}, }, "videoPerformanceAd": { # Details for a video performance ad. # Optional. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. - "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. + "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. Must be set if headlines is set. "A String", ], "companionBanners": [ # Optional. The list of companion banners used by this ad. @@ -1104,20 +1104,20 @@Method Details
"customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, - "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. + "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL. - "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. + "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. Can only be set if displayUrlBreadcrumb1 is also set. "domain": "A String", # Output only. The domain of the display URL. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "headlines": [ # Optional. The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. + "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "videos": [ # Required. The list of YouTube video assets used by this ad. { # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. @@ -1131,11 +1131,11 @@Method Details
@@ -556,10 +556,10 @@delete(advertiserId, adGroupAdId, x__xgafv=None)-Deletes an ad group ad. This method is only supported for Demand Gen ads. +Deletes an ad group ad. Args: advertiserId: string, Required. The ID of the advertiser the ad belongs to. (required) - adGroupAdId: string, Required. The ID of the ad to delete. Only Demand Gen ads are supported. (required) + adGroupAdId: string, Required. The ID of the ad to delete. (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1163,7 +1163,7 @@Method Details
Returns: An object of the form: - { # LINT: LEGACY_NAMES A single ad associated with an ad group. + { # A single ad associated with an ad group. "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. "adGroupId": "A String", # Required. Immutable. The unique ID of the ad group that the ad belongs to. "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. @@ -1309,7 +1309,7 @@Method Details
"audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives. "displayUrl": "A String", # The webpage address that appears with the ad. "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -1318,7 +1318,7 @@Method Details
}, "bumperAd": { # Details for a bumper ad. # Optional. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -1331,7 +1331,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -1339,7 +1339,7 @@Method Details
}, }, }, - "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. To remove the DCM tracking ad info, please leave this field empty. "creativeId": "A String", # Required. The DCM creative id. "placementId": "A String", # Required. The DCM placement id. "trackingAdId": "A String", # Required. The DCM tracking ad id. @@ -1541,7 +1541,7 @@Method Details
"entityStatus": "A String", # Required. The entity status of the ad. "inStreamAd": { # Details for an in-stream ad. # Optional. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -1554,7 +1554,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -1591,7 +1591,7 @@Method Details
"name": "A String", # Output only. The resource name of the ad. "nonSkippableAd": { # Details for a non-skippable ad. # Optional. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -1604,7 +1604,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -1627,7 +1627,7 @@Method Details
}, }, "videoPerformanceAd": { # Details for a video performance ad. # Optional. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. - "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. + "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. Must be set if headlines is set. "A String", ], "companionBanners": [ # Optional. The list of companion banners used by this ad. @@ -1644,20 +1644,20 @@Method Details
"customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, - "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. + "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL. - "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. + "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. Can only be set if displayUrlBreadcrumb1 is also set. "domain": "A String", # Output only. The domain of the display URL. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "headlines": [ # Optional. The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. + "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "videos": [ # Required. The list of YouTube video assets used by this ad. { # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. @@ -1689,7 +1689,7 @@Method Details
{ "adGroupAds": [ # The list of ads. This list will be absent if empty. - { # LINT: LEGACY_NAMES A single ad associated with an ad group. + { # A single ad associated with an ad group. "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. "adGroupId": "A String", # Required. Immutable. The unique ID of the ad group that the ad belongs to. "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. @@ -1835,7 +1835,7 @@Method Details
"audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives. "displayUrl": "A String", # The webpage address that appears with the ad. "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -1844,7 +1844,7 @@Method Details
}, "bumperAd": { # Details for a bumper ad. # Optional. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -1857,7 +1857,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -1865,7 +1865,7 @@Method Details
}, }, }, - "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. To remove the DCM tracking ad info, please leave this field empty. "creativeId": "A String", # Required. The DCM creative id. "placementId": "A String", # Required. The DCM placement id. "trackingAdId": "A String", # Required. The DCM tracking ad id. @@ -2067,7 +2067,7 @@Method Details
"entityStatus": "A String", # Required. The entity status of the ad. "inStreamAd": { # Details for an in-stream ad. # Optional. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -2080,7 +2080,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -2117,7 +2117,7 @@Method Details
"name": "A String", # Output only. The resource name of the ad. "nonSkippableAd": { # Details for a non-skippable ad. # Optional. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -2130,7 +2130,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -2153,7 +2153,7 @@Method Details
}, }, "videoPerformanceAd": { # Details for a video performance ad. # Optional. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. - "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. + "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. Must be set if headlines is set. "A String", ], "companionBanners": [ # Optional. The list of companion banners used by this ad. @@ -2170,20 +2170,20 @@Method Details
"customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, - "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. + "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL. - "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. + "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. Can only be set if displayUrlBreadcrumb1 is also set. "domain": "A String", # Output only. The domain of the display URL. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "headlines": [ # Optional. The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. + "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "videos": [ # Required. The list of YouTube video assets used by this ad. { # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. @@ -2214,7 +2214,7 @@Method Details
@@ -408,10 +408,10 @@patch(advertiserId, adGroupAdId, body=None, updateMask=None, x__xgafv=None)-Updates an ad group ad. This method is only supported for Demand Gen ads. +Updates an ad group ad. Args: advertiserId: string, Output only. The unique ID of the advertiser the ad belongs to. (required) @@ -2222,7 +2222,7 @@Method Details
body: object, The request body. The object takes the form of: -{ # LINT: LEGACY_NAMES A single ad associated with an ad group. +{ # A single ad associated with an ad group. "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. "adGroupId": "A String", # Required. Immutable. The unique ID of the ad group that the ad belongs to. "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. @@ -2368,7 +2368,7 @@Method Details
"audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives. "displayUrl": "A String", # The webpage address that appears with the ad. "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -2377,7 +2377,7 @@Method Details
}, "bumperAd": { # Details for a bumper ad. # Optional. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -2390,7 +2390,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -2398,7 +2398,7 @@Method Details
}, }, }, - "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. To remove the DCM tracking ad info, please leave this field empty. "creativeId": "A String", # Required. The DCM creative id. "placementId": "A String", # Required. The DCM placement id. "trackingAdId": "A String", # Required. The DCM tracking ad id. @@ -2600,7 +2600,7 @@Method Details
"entityStatus": "A String", # Required. The entity status of the ad. "inStreamAd": { # Details for an in-stream ad. # Optional. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -2613,7 +2613,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -2650,7 +2650,7 @@Method Details
"name": "A String", # Output only. The resource name of the ad. "nonSkippableAd": { # Details for a non-skippable ad. # Optional. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -2663,7 +2663,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -2686,7 +2686,7 @@Method Details
}, }, "videoPerformanceAd": { # Details for a video performance ad. # Optional. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. - "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. + "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. Must be set if headlines is set. "A String", ], "companionBanners": [ # Optional. The list of companion banners used by this ad. @@ -2703,20 +2703,20 @@Method Details
"customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, - "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. + "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL. - "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. + "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. Can only be set if displayUrlBreadcrumb1 is also set. "domain": "A String", # Output only. The domain of the display URL. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "headlines": [ # Optional. The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. + "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "videos": [ # Required. The list of YouTube video assets used by this ad. { # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. @@ -2736,7 +2736,7 @@Method Details
Returns: An object of the form: - { # LINT: LEGACY_NAMES A single ad associated with an ad group. + { # A single ad associated with an ad group. "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. "adGroupId": "A String", # Required. Immutable. The unique ID of the ad group that the ad belongs to. "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. @@ -2882,7 +2882,7 @@Method Details
"audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives. "displayUrl": "A String", # The webpage address that appears with the ad. "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -2891,7 +2891,7 @@Method Details
}, "bumperAd": { # Details for a bumper ad. # Optional. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -2904,7 +2904,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -2912,7 +2912,7 @@Method Details
}, }, }, - "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. To remove the DCM tracking ad info, please leave this field empty. "creativeId": "A String", # Required. The DCM creative id. "placementId": "A String", # Required. The DCM placement id. "trackingAdId": "A String", # Required. The DCM tracking ad id. @@ -3114,7 +3114,7 @@Method Details
"entityStatus": "A String", # Required. The entity status of the ad. "inStreamAd": { # Details for an in-stream ad. # Optional. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -3127,7 +3127,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -3164,7 +3164,7 @@Method Details
"name": "A String", # Output only. The resource name of the ad. "nonSkippableAd": { # Details for a non-skippable ad. # Optional. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -3177,7 +3177,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -3200,7 +3200,7 @@Method Details
}, }, "videoPerformanceAd": { # Details for a video performance ad. # Optional. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. - "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. + "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. Must be set if headlines is set. "A String", ], "companionBanners": [ # Optional. The list of companion banners used by this ad. @@ -3217,20 +3217,20 @@Method Details
"customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, - "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. + "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL. - "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. + "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. Can only be set if displayUrlBreadcrumb1 is also set. "domain": "A String", # Output only. The domain of the display URL. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "headlines": [ # Optional. The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. + "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "videos": [ # Required. The list of YouTube video assets used by this ad. { # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroups.html b/docs/dyn/displayvideo_v3.advertisers.adGroups.html index 43d6b86c8d..befc99e766 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroups.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroups.html @@ -890,7 +890,7 @@Method Details
body: object, The request body. The object takes the form of: -{ # A single ad group associated with a line item. +{ # LINT: LEGACY_NAMES A single ad group associated with a line item. "adGroupFormat": "A String", # Required. Immutable. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group. @@ -965,7 +965,7 @@Method Details
Returns: An object of the form: - { # A single ad group associated with a line item. + { # LINT: LEGACY_NAMES A single ad group associated with a line item. "adGroupFormat": "A String", # Required. Immutable. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group. @@ -1067,7 +1067,7 @@Method Details
Returns: An object of the form: - { # A single ad group associated with a line item. + { # LINT: LEGACY_NAMES A single ad group associated with a line item. "adGroupFormat": "A String", # Required. Immutable. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group. @@ -1155,7 +1155,7 @@Method Details
{ "adGroups": [ # The list of ad groups. This list will be absent if empty. - { # A single ad group associated with a line item. + { # LINT: LEGACY_NAMES A single ad group associated with a line item. "adGroupFormat": "A String", # Required. Immutable. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group. @@ -1250,7 +1250,7 @@Method Details
body: object, The request body. The object takes the form of: -{ # A single ad group associated with a line item. +{ # LINT: LEGACY_NAMES A single ad group associated with a line item. "adGroupFormat": "A String", # Required. Immutable. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group. @@ -1326,7 +1326,7 @@Method Details
Returns: An object of the form: - { # A single ad group associated with a line item. + { # LINT: LEGACY_NAMES A single ad group associated with a line item. "adGroupFormat": "A String", # Required. Immutable. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group. diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html index 844e289c24..d0646df6a0 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html @@ -129,7 +129,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -866,7 +865,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -938,7 +936,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -1340,7 +1337,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). diff --git a/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html index 4bf2df7563..1d61db6264 100644 --- a/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html @@ -129,7 +129,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -866,7 +865,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -938,7 +936,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -1340,7 +1337,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). diff --git a/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html index 74360bbe1f..c07f14d030 100644 --- a/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html @@ -128,7 +128,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -864,7 +863,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -935,7 +933,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -1336,7 +1333,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). diff --git a/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html index a4546bfa30..61b62e2852 100644 --- a/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html @@ -128,7 +128,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -864,7 +863,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -935,7 +933,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -1336,7 +1333,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). diff --git a/docs/dyn/displayvideo_v3.targetingTypes.targetingOptions.html b/docs/dyn/displayvideo_v3.targetingTypes.targetingOptions.html index eb40225754..c1210bd41c 100644 --- a/docs/dyn/displayvideo_v3.targetingTypes.targetingOptions.html +++ b/docs/dyn/displayvideo_v3.targetingTypes.targetingOptions.html @@ -127,7 +127,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -309,7 +308,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). @@ -513,7 +511,6 @@Method Details
TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position. TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify). TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences). - TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult). TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app). TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange). TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS). diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html b/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html index 71562d4cd9..245001d788 100644 --- a/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html +++ b/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html @@ -79,10 +79,10 @@Instance Methods
Close httplib2 connections.
-
create(advertiserId, body=None, x__xgafv=None)Creates an ad group ad. This method is only supported for Demand Gen ads.
+Creates an ad group ad.
-
delete(advertiserId, adGroupAdId, x__xgafv=None)Deletes an ad group ad. This method is only supported for Demand Gen ads.
+Deletes an ad group ad.
get(advertiserId, adGroupAdId, x__xgafv=None)Gets an ad group ad.
@@ -94,7 +94,7 @@Instance Methods
Retrieves the next page of results.
-
patch(advertiserId, adGroupAdId, body=None, updateMask=None, x__xgafv=None)Updates an ad group ad. This method is only supported for Demand Gen ads.
+Updates an ad group ad.
Method Details
@@ -355,10 +355,10 @@close()@@ -103,14 +103,14 @@Method Details
@@ -305,10 +305,10 @@create(advertiserId, body=None, x__xgafv=None)-Creates an ad group ad. This method is only supported for Demand Gen ads. +Creates an ad group ad. Args: advertiserId: string, Output only. The unique ID of the advertiser the ad belongs to. (required) body: object, The request body. The object takes the form of: -{ # LINT: LEGACY_NAMES A single ad associated with an ad group. +{ # A single ad associated with an ad group. "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. "adGroupId": "A String", # Required. Immutable. The unique ID of the ad group that the ad belongs to. "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. @@ -256,7 +256,7 @@Method Details
"audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives. "displayUrl": "A String", # The webpage address that appears with the ad. "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -265,7 +265,7 @@Method Details
}, "bumperAd": { # Details for a bumper ad. # Optional. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -278,7 +278,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -286,7 +286,7 @@Method Details
}, }, }, - "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. To remove the DCM tracking ad info, please leave this field empty. "creativeId": "A String", # Required. The DCM creative id. "placementId": "A String", # Required. The DCM placement id. "trackingAdId": "A String", # Required. The DCM tracking ad id. @@ -488,7 +488,7 @@Method Details
"entityStatus": "A String", # Required. The entity status of the ad. "inStreamAd": { # Details for an in-stream ad. # Optional. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -501,7 +501,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -538,7 +538,7 @@Method Details
"name": "A String", # Output only. The resource name of the ad. "nonSkippableAd": { # Details for a non-skippable ad. # Optional. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -551,7 +551,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -574,7 +574,7 @@Method Details
}, }, "videoPerformanceAd": { # Details for a video performance ad. # Optional. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. - "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. + "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. Must be set if headlines is set. "A String", ], "companionBanners": [ # Optional. The list of companion banners used by this ad. @@ -591,20 +591,20 @@Method Details
"customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, - "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. + "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL. - "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. + "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. Can only be set if displayUrlBreadcrumb1 is also set. "domain": "A String", # Output only. The domain of the display URL. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "headlines": [ # Optional. The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. + "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "videos": [ # Required. The list of YouTube video assets used by this ad. { # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. @@ -623,7 +623,7 @@Method Details
Returns: An object of the form: - { # LINT: LEGACY_NAMES A single ad associated with an ad group. + { # A single ad associated with an ad group. "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. "adGroupId": "A String", # Required. Immutable. The unique ID of the ad group that the ad belongs to. "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. @@ -769,7 +769,7 @@Method Details
"audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives. "displayUrl": "A String", # The webpage address that appears with the ad. "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -778,7 +778,7 @@Method Details
}, "bumperAd": { # Details for a bumper ad. # Optional. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -791,7 +791,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -799,7 +799,7 @@Method Details
}, }, }, - "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. To remove the DCM tracking ad info, please leave this field empty. "creativeId": "A String", # Required. The DCM creative id. "placementId": "A String", # Required. The DCM placement id. "trackingAdId": "A String", # Required. The DCM tracking ad id. @@ -1001,7 +1001,7 @@Method Details
"entityStatus": "A String", # Required. The entity status of the ad. "inStreamAd": { # Details for an in-stream ad. # Optional. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -1014,7 +1014,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -1051,7 +1051,7 @@Method Details
"name": "A String", # Output only. The resource name of the ad. "nonSkippableAd": { # Details for a non-skippable ad. # Optional. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -1064,7 +1064,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -1087,7 +1087,7 @@Method Details
}, }, "videoPerformanceAd": { # Details for a video performance ad. # Optional. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. - "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. + "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. Must be set if headlines is set. "A String", ], "companionBanners": [ # Optional. The list of companion banners used by this ad. @@ -1104,20 +1104,20 @@Method Details
"customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, - "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. + "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL. - "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. + "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. Can only be set if displayUrlBreadcrumb1 is also set. "domain": "A String", # Output only. The domain of the display URL. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "headlines": [ # Optional. The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. + "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "videos": [ # Required. The list of YouTube video assets used by this ad. { # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. @@ -1131,11 +1131,11 @@Method Details
@@ -248,10 +248,10 @@delete(advertiserId, adGroupAdId, x__xgafv=None)-Deletes an ad group ad. This method is only supported for Demand Gen ads. +Deletes an ad group ad. Args: advertiserId: string, Required. The ID of the advertiser the ad belongs to. (required) - adGroupAdId: string, Required. The ID of the ad to delete. Only Demand Gen ads are supported. (required) + adGroupAdId: string, Required. The ID of the ad to delete. (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1163,7 +1163,7 @@Method Details
Returns: An object of the form: - { # LINT: LEGACY_NAMES A single ad associated with an ad group. + { # A single ad associated with an ad group. "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. "adGroupId": "A String", # Required. Immutable. The unique ID of the ad group that the ad belongs to. "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. @@ -1309,7 +1309,7 @@Method Details
"audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives. "displayUrl": "A String", # The webpage address that appears with the ad. "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -1318,7 +1318,7 @@Method Details
}, "bumperAd": { # Details for a bumper ad. # Optional. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -1331,7 +1331,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -1339,7 +1339,7 @@Method Details
}, }, }, - "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. To remove the DCM tracking ad info, please leave this field empty. "creativeId": "A String", # Required. The DCM creative id. "placementId": "A String", # Required. The DCM placement id. "trackingAdId": "A String", # Required. The DCM tracking ad id. @@ -1541,7 +1541,7 @@Method Details
"entityStatus": "A String", # Required. The entity status of the ad. "inStreamAd": { # Details for an in-stream ad. # Optional. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -1554,7 +1554,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -1591,7 +1591,7 @@Method Details
"name": "A String", # Output only. The resource name of the ad. "nonSkippableAd": { # Details for a non-skippable ad. # Optional. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -1604,7 +1604,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -1627,7 +1627,7 @@Method Details
}, }, "videoPerformanceAd": { # Details for a video performance ad. # Optional. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. - "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. + "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. Must be set if headlines is set. "A String", ], "companionBanners": [ # Optional. The list of companion banners used by this ad. @@ -1644,20 +1644,20 @@Method Details
"customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, - "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. + "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL. - "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. + "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. Can only be set if displayUrlBreadcrumb1 is also set. "domain": "A String", # Output only. The domain of the display URL. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "headlines": [ # Optional. The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. + "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "videos": [ # Required. The list of YouTube video assets used by this ad. { # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. @@ -1689,7 +1689,7 @@Method Details
{ "adGroupAds": [ # The list of ads. This list will be absent if empty. - { # LINT: LEGACY_NAMES A single ad associated with an ad group. + { # A single ad associated with an ad group. "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. "adGroupId": "A String", # Required. Immutable. The unique ID of the ad group that the ad belongs to. "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. @@ -1835,7 +1835,7 @@Method Details
"audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives. "displayUrl": "A String", # The webpage address that appears with the ad. "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -1844,7 +1844,7 @@Method Details
}, "bumperAd": { # Details for a bumper ad. # Optional. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -1857,7 +1857,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -1865,7 +1865,7 @@Method Details
}, }, }, - "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. To remove the DCM tracking ad info, please leave this field empty. "creativeId": "A String", # Required. The DCM creative id. "placementId": "A String", # Required. The DCM placement id. "trackingAdId": "A String", # Required. The DCM tracking ad id. @@ -2067,7 +2067,7 @@Method Details
"entityStatus": "A String", # Required. The entity status of the ad. "inStreamAd": { # Details for an in-stream ad. # Optional. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -2080,7 +2080,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -2117,7 +2117,7 @@Method Details
"name": "A String", # Output only. The resource name of the ad. "nonSkippableAd": { # Details for a non-skippable ad. # Optional. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -2130,7 +2130,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -2153,7 +2153,7 @@Method Details
}, }, "videoPerformanceAd": { # Details for a video performance ad. # Optional. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. - "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. + "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. Must be set if headlines is set. "A String", ], "companionBanners": [ # Optional. The list of companion banners used by this ad. @@ -2170,20 +2170,20 @@Method Details
"customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, - "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. + "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL. - "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. + "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. Can only be set if displayUrlBreadcrumb1 is also set. "domain": "A String", # Output only. The domain of the display URL. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "headlines": [ # Optional. The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. + "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "videos": [ # Required. The list of YouTube video assets used by this ad. { # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. @@ -2214,7 +2214,7 @@Method Details
@@ -186,10 +186,10 @@patch(advertiserId, adGroupAdId, body=None, updateMask=None, x__xgafv=None)-Updates an ad group ad. This method is only supported for Demand Gen ads. +Updates an ad group ad. Args: advertiserId: string, Output only. The unique ID of the advertiser the ad belongs to. (required) @@ -2222,7 +2222,7 @@Method Details
body: object, The request body. The object takes the form of: -{ # LINT: LEGACY_NAMES A single ad associated with an ad group. +{ # A single ad associated with an ad group. "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. "adGroupId": "A String", # Required. Immutable. The unique ID of the ad group that the ad belongs to. "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. @@ -2368,7 +2368,7 @@Method Details
"audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives. "displayUrl": "A String", # The webpage address that appears with the ad. "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -2377,7 +2377,7 @@Method Details
}, "bumperAd": { # Details for a bumper ad. # Optional. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -2390,7 +2390,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -2398,7 +2398,7 @@Method Details
}, }, }, - "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. To remove the DCM tracking ad info, please leave this field empty. "creativeId": "A String", # Required. The DCM creative id. "placementId": "A String", # Required. The DCM placement id. "trackingAdId": "A String", # Required. The DCM tracking ad id. @@ -2600,7 +2600,7 @@Method Details
"entityStatus": "A String", # Required. The entity status of the ad. "inStreamAd": { # Details for an in-stream ad. # Optional. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -2613,7 +2613,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -2650,7 +2650,7 @@Method Details
"name": "A String", # Output only. The resource name of the ad. "nonSkippableAd": { # Details for a non-skippable ad. # Optional. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -2663,7 +2663,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -2686,7 +2686,7 @@Method Details
}, }, "videoPerformanceAd": { # Details for a video performance ad. # Optional. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. - "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. + "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. Must be set if headlines is set. "A String", ], "companionBanners": [ # Optional. The list of companion banners used by this ad. @@ -2703,20 +2703,20 @@Method Details
"customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, - "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. + "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL. - "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. + "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. Can only be set if displayUrlBreadcrumb1 is also set. "domain": "A String", # Output only. The domain of the display URL. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "headlines": [ # Optional. The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. + "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "videos": [ # Required. The list of YouTube video assets used by this ad. { # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. @@ -2736,7 +2736,7 @@Method Details
Returns: An object of the form: - { # LINT: LEGACY_NAMES A single ad associated with an ad group. + { # A single ad associated with an ad group. "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. "adGroupId": "A String", # Required. Immutable. The unique ID of the ad group that the ad belongs to. "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. @@ -2882,7 +2882,7 @@Method Details
"audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives. "displayUrl": "A String", # The webpage address that appears with the ad. "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -2891,7 +2891,7 @@Method Details
}, "bumperAd": { # Details for a bumper ad. # Optional. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -2904,7 +2904,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -2912,7 +2912,7 @@Method Details
}, }, }, - "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. To remove the DCM tracking ad info, please leave this field empty. "creativeId": "A String", # Required. The DCM creative id. "placementId": "A String", # Required. The DCM placement id. "trackingAdId": "A String", # Required. The DCM tracking ad id. @@ -3114,7 +3114,7 @@Method Details
"entityStatus": "A String", # Required. The entity status of the ad. "inStreamAd": { # Details for an in-stream ad. # Optional. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -3127,7 +3127,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -3164,7 +3164,7 @@Method Details
"name": "A String", # Output only. The resource name of the ad. "nonSkippableAd": { # Details for a non-skippable ad. # Optional. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives. "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Required. Common ad attributes. - "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. + "actionButtonLabel": "A String", # Optional. The text on the call-to-action button. Must be set if actionHeadline is set. "actionHeadline": "A String", # Optional. The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # Optional. The image which shows next to the video ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -3177,7 +3177,7 @@Method Details
}, "displayUrl": "A String", # Required. The webpage address that appears with the ad. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "video": { # Details of a YouTube video. # Required. Immutable. The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # Output only. The reason why the video data is not available. @@ -3200,7 +3200,7 @@Method Details
}, }, "videoPerformanceAd": { # Details for a video performance ad. # Optional. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. - "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. + "actionButtonLabels": [ # Optional. The list of text assets shown on the call-to-action button. Must be set if headlines is set. "A String", ], "companionBanners": [ # Optional. The list of companion banners used by this ad. @@ -3217,20 +3217,20 @@Method Details
"customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, - "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. + "descriptions": [ # Optional. The list of descriptions shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL. - "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. + "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. Can only be set if displayUrlBreadcrumb1 is also set. "domain": "A String", # Output only. The domain of the display URL. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "headlines": [ # Optional. The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. + "longHeadlines": [ # Optional. The list of long headlines shown on the call-to-action banner. Must be set unless the parent line item's lineItemType is `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`, in which case this field cannot be set. "A String", ], - "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. In v4 and earlier, this field represents the tracking URL specified by the user manually. This can be found at userSpecifiedTrackingUrl in v5. "videos": [ # Required. The list of YouTube video assets used by this ad. { # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroups.html b/docs/dyn/displayvideo_v4.advertisers.adGroups.html index c228c02877..6601e66582 100644 --- a/docs/dyn/displayvideo_v4.advertisers.adGroups.html +++ b/docs/dyn/displayvideo_v4.advertisers.adGroups.html @@ -895,7 +895,7 @@Method Details
body: object, The request body. The object takes the form of: -{ # A single ad group associated with a line item. +{ # LINT: LEGACY_NAMES A single ad group associated with a line item. "adGroupFormat": "A String", # Required. Immutable. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group. @@ -972,7 +972,7 @@Method Details
Returns: An object of the form: - { # A single ad group associated with a line item. + { # LINT: LEGACY_NAMES A single ad group associated with a line item. "adGroupFormat": "A String", # Required. Immutable. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group. @@ -1076,7 +1076,7 @@Method Details
Returns: An object of the form: - { # A single ad group associated with a line item. + { # LINT: LEGACY_NAMES A single ad group associated with a line item. "adGroupFormat": "A String", # Required. Immutable. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group. @@ -1166,7 +1166,7 @@Method Details
{ "adGroups": [ # The list of ad groups. This list will be absent if empty. - { # A single ad group associated with a line item. + { # LINT: LEGACY_NAMES A single ad group associated with a line item. "adGroupFormat": "A String", # Required. Immutable. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group. @@ -1263,7 +1263,7 @@Method Details
body: object, The request body. The object takes the form of: -{ # A single ad group associated with a line item. +{ # LINT: LEGACY_NAMES A single ad group associated with a line item. "adGroupFormat": "A String", # Required. Immutable. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group. @@ -1341,7 +1341,7 @@Method Details
Returns: An object of the form: - { # A single ad group associated with a line item. + { # LINT: LEGACY_NAMES A single ad group associated with a line item. "adGroupFormat": "A String", # Required. Immutable. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group. diff --git a/docs/dyn/dns_v1.outboundEndpoints.html b/docs/dyn/dns_v1.outboundEndpoints.html index 1c92da74cd..b4ded49817 100644 --- a/docs/dyn/dns_v1.outboundEndpoints.html +++ b/docs/dyn/dns_v1.outboundEndpoints.html @@ -116,7 +116,7 @@Method Details
}, "createTime": "A String", # Output only. [Output only] Create time stamp "description": "A String", # Optional. User provided description. - "endpointIp": "A String", # Required. Immutable. User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. + "endpointIp": "A String", # Optional. Immutable. User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated. "labels": { # Optional. Labels as key value pairs "a_key": "A String", }, @@ -219,7 +219,7 @@Method Details
}, "createTime": "A String", # Output only. [Output only] Create time stamp "description": "A String", # Optional. User provided description. - "endpointIp": "A String", # Required. Immutable. User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. + "endpointIp": "A String", # Optional. Immutable. User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated. "labels": { # Optional. Labels as key value pairs "a_key": "A String", }, @@ -259,7 +259,7 @@Method Details
}, "createTime": "A String", # Output only. [Output only] Create time stamp "description": "A String", # Optional. User provided description. - "endpointIp": "A String", # Required. Immutable. User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. + "endpointIp": "A String", # Optional. Immutable. User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated. "labels": { # Optional. Labels as key value pairs "a_key": "A String", }, @@ -307,7 +307,7 @@Method Details
}, "createTime": "A String", # Output only. [Output only] Create time stamp "description": "A String", # Optional. User provided description. - "endpointIp": "A String", # Required. Immutable. User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. + "endpointIp": "A String", # Optional. Immutable. User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated. "labels": { # Optional. Labels as key value pairs "a_key": "A String", }, diff --git a/docs/dyn/dns_v1beta2.outboundEndpoints.html b/docs/dyn/dns_v1beta2.outboundEndpoints.html index 4324275bbc..5e68beb11b 100644 --- a/docs/dyn/dns_v1beta2.outboundEndpoints.html +++ b/docs/dyn/dns_v1beta2.outboundEndpoints.html @@ -116,7 +116,7 @@Method Details
}, "createTime": "A String", # Output only. [Output only] Create time stamp "description": "A String", # Optional. User provided description. - "endpointIp": "A String", # Required. Immutable. User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. + "endpointIp": "A String", # Optional. Immutable. User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated. "labels": { # Optional. Labels as key value pairs "a_key": "A String", }, @@ -219,7 +219,7 @@Method Details
}, "createTime": "A String", # Output only. [Output only] Create time stamp "description": "A String", # Optional. User provided description. - "endpointIp": "A String", # Required. Immutable. User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. + "endpointIp": "A String", # Optional. Immutable. User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated. "labels": { # Optional. Labels as key value pairs "a_key": "A String", }, @@ -259,7 +259,7 @@Method Details
}, "createTime": "A String", # Output only. [Output only] Create time stamp "description": "A String", # Optional. User provided description. - "endpointIp": "A String", # Required. Immutable. User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. + "endpointIp": "A String", # Optional. Immutable. User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated. "labels": { # Optional. Labels as key value pairs "a_key": "A String", }, @@ -307,7 +307,7 @@Method Details
}, "createTime": "A String", # Output only. [Output only] Create time stamp "description": "A String", # Optional. User provided description. - "endpointIp": "A String", # Required. Immutable. User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. + "endpointIp": "A String", # Optional. Immutable. User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated. "labels": { # Optional. Labels as key value pairs "a_key": "A String", }, diff --git a/docs/dyn/drive_v3.approvals.html b/docs/dyn/drive_v3.approvals.html index 1526332682..83702c099f 100644 --- a/docs/dyn/drive_v3.approvals.html +++ b/docs/dyn/drive_v3.approvals.html @@ -129,10 +129,10 @@Method Details
{ # Metadata for an approval. An approval is a review or approve process for a Drive item. "approvalId": "A String", # The approval ID. - "completeTime": "A String", # Output only. The time the approval was completed. - "createTime": "A String", # Output only. The time the approval was created. + "completeTime": "A String", # The time the approval was completed. + "createTime": "A String", # The time the approval was created. "dueTime": "A String", # The time that the approval is due. - "fileContentChangeBehavior": "A String", # Output only. The behavior of the approval when the file content changes. + "fileContentChangeBehavior": "A String", # The behavior of the approval when the file content changes. "initiator": { # Information about a Drive user. # The user that requested the approval. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -142,7 +142,7 @@Method Details
"photoLink": "A String", # Output only. A link to the user's profile photo, if available. }, "kind": "A String", # This is always drive#approval. - "modifyTime": "A String", # Output only. The most recent time the approval was modified. + "modifyTime": "A String", # The most recent time the approval was modified. "reviewerResponses": [ # The responses made on the approval by reviewers. { # A response on an approval made by a specific reviewer. "kind": "A String", # This is always drive#reviewerResponse. @@ -157,7 +157,7 @@Method Details
}, }, ], - "status": "A String", # Output only. The status of the approval at the time this resource was requested. + "status": "A String", # The status of the approval at the time this resource was requested. "targetFileId": "A String", # Target file id of the approval. }Method Details
{ # Metadata for an approval. An approval is a review or approve process for a Drive item. "approvalId": "A String", # The approval ID. - "completeTime": "A String", # Output only. The time the approval was completed. - "createTime": "A String", # Output only. The time the approval was created. + "completeTime": "A String", # The time the approval was completed. + "createTime": "A String", # The time the approval was created. "dueTime": "A String", # The time that the approval is due. - "fileContentChangeBehavior": "A String", # Output only. The behavior of the approval when the file content changes. + "fileContentChangeBehavior": "A String", # The behavior of the approval when the file content changes. "initiator": { # Information about a Drive user. # The user that requested the approval. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -199,7 +199,7 @@Method Details
"photoLink": "A String", # Output only. A link to the user's profile photo, if available. }, "kind": "A String", # This is always drive#approval. - "modifyTime": "A String", # Output only. The most recent time the approval was modified. + "modifyTime": "A String", # The most recent time the approval was modified. "reviewerResponses": [ # The responses made on the approval by reviewers. { # A response on an approval made by a specific reviewer. "kind": "A String", # This is always drive#reviewerResponse. @@ -214,7 +214,7 @@Method Details
}, }, ], - "status": "A String", # Output only. The status of the approval at the time this resource was requested. + "status": "A String", # The status of the approval at the time this resource was requested. "targetFileId": "A String", # Target file id of the approval. }Method Details
{ # Metadata for an approval. An approval is a review or approve process for a Drive item. "approvalId": "A String", # The approval ID. - "completeTime": "A String", # Output only. The time the approval was completed. - "createTime": "A String", # Output only. The time the approval was created. + "completeTime": "A String", # The time the approval was completed. + "createTime": "A String", # The time the approval was created. "dueTime": "A String", # The time that the approval is due. - "fileContentChangeBehavior": "A String", # Output only. The behavior of the approval when the file content changes. + "fileContentChangeBehavior": "A String", # The behavior of the approval when the file content changes. "initiator": { # Information about a Drive user. # The user that requested the approval. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -261,7 +261,7 @@Method Details
"photoLink": "A String", # Output only. A link to the user's profile photo, if available. }, "kind": "A String", # This is always drive#approval. - "modifyTime": "A String", # Output only. The most recent time the approval was modified. + "modifyTime": "A String", # The most recent time the approval was modified. "reviewerResponses": [ # The responses made on the approval by reviewers. { # A response on an approval made by a specific reviewer. "kind": "A String", # This is always drive#reviewerResponse. @@ -276,7 +276,7 @@Method Details
}, }, ], - "status": "A String", # Output only. The status of the approval at the time this resource was requested. + "status": "A String", # The status of the approval at the time this resource was requested. "targetFileId": "A String", # Target file id of the approval. }Method Details
{ # Metadata for an approval. An approval is a review or approve process for a Drive item. "approvalId": "A String", # The approval ID. - "completeTime": "A String", # Output only. The time the approval was completed. - "createTime": "A String", # Output only. The time the approval was created. + "completeTime": "A String", # The time the approval was completed. + "createTime": "A String", # The time the approval was created. "dueTime": "A String", # The time that the approval is due. - "fileContentChangeBehavior": "A String", # Output only. The behavior of the approval when the file content changes. + "fileContentChangeBehavior": "A String", # The behavior of the approval when the file content changes. "initiator": { # Information about a Drive user. # The user that requested the approval. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -318,7 +318,7 @@Method Details
"photoLink": "A String", # Output only. A link to the user's profile photo, if available. }, "kind": "A String", # This is always drive#approval. - "modifyTime": "A String", # Output only. The most recent time the approval was modified. + "modifyTime": "A String", # The most recent time the approval was modified. "reviewerResponses": [ # The responses made on the approval by reviewers. { # A response on an approval made by a specific reviewer. "kind": "A String", # This is always drive#reviewerResponse. @@ -333,7 +333,7 @@Method Details
}, }, ], - "status": "A String", # Output only. The status of the approval at the time this resource was requested. + "status": "A String", # The status of the approval at the time this resource was requested. "targetFileId": "A String", # Target file id of the approval. }Method Details
{ # Metadata for an approval. An approval is a review or approve process for a Drive item. "approvalId": "A String", # The approval ID. - "completeTime": "A String", # Output only. The time the approval was completed. - "createTime": "A String", # Output only. The time the approval was created. + "completeTime": "A String", # The time the approval was completed. + "createTime": "A String", # The time the approval was created. "dueTime": "A String", # The time that the approval is due. - "fileContentChangeBehavior": "A String", # Output only. The behavior of the approval when the file content changes. + "fileContentChangeBehavior": "A String", # The behavior of the approval when the file content changes. "initiator": { # Information about a Drive user. # The user that requested the approval. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -368,7 +368,7 @@Method Details
"photoLink": "A String", # Output only. A link to the user's profile photo, if available. }, "kind": "A String", # This is always drive#approval. - "modifyTime": "A String", # Output only. The most recent time the approval was modified. + "modifyTime": "A String", # The most recent time the approval was modified. "reviewerResponses": [ # The responses made on the approval by reviewers. { # A response on an approval made by a specific reviewer. "kind": "A String", # This is always drive#reviewerResponse. @@ -383,7 +383,7 @@Method Details
}, }, ], - "status": "A String", # Output only. The status of the approval at the time this resource was requested. + "status": "A String", # The status of the approval at the time this resource was requested. "targetFileId": "A String", # Target file id of the approval. }Method Details
"items": [ # The list of approvals. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched. { # Metadata for an approval. An approval is a review or approve process for a Drive item. "approvalId": "A String", # The approval ID. - "completeTime": "A String", # Output only. The time the approval was completed. - "createTime": "A String", # Output only. The time the approval was created. + "completeTime": "A String", # The time the approval was completed. + "createTime": "A String", # The time the approval was created. "dueTime": "A String", # The time that the approval is due. - "fileContentChangeBehavior": "A String", # Output only. The behavior of the approval when the file content changes. + "fileContentChangeBehavior": "A String", # The behavior of the approval when the file content changes. "initiator": { # Information about a Drive user. # The user that requested the approval. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -421,7 +421,7 @@Method Details
"photoLink": "A String", # Output only. A link to the user's profile photo, if available. }, "kind": "A String", # This is always drive#approval. - "modifyTime": "A String", # Output only. The most recent time the approval was modified. + "modifyTime": "A String", # The most recent time the approval was modified. "reviewerResponses": [ # The responses made on the approval by reviewers. { # A response on an approval made by a specific reviewer. "kind": "A String", # This is always drive#reviewerResponse. @@ -436,7 +436,7 @@Method Details
}, }, ], - "status": "A String", # Output only. The status of the approval at the time this resource was requested. + "status": "A String", # The status of the approval at the time this resource was requested. "targetFileId": "A String", # Target file id of the approval. }, ], @@ -494,10 +494,10 @@Method Details
{ # Metadata for an approval. An approval is a review or approve process for a Drive item. "approvalId": "A String", # The approval ID. - "completeTime": "A String", # Output only. The time the approval was completed. - "createTime": "A String", # Output only. The time the approval was created. + "completeTime": "A String", # The time the approval was completed. + "createTime": "A String", # The time the approval was created. "dueTime": "A String", # The time that the approval is due. - "fileContentChangeBehavior": "A String", # Output only. The behavior of the approval when the file content changes. + "fileContentChangeBehavior": "A String", # The behavior of the approval when the file content changes. "initiator": { # Information about a Drive user. # The user that requested the approval. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -507,7 +507,7 @@Method Details
"photoLink": "A String", # Output only. A link to the user's profile photo, if available. }, "kind": "A String", # This is always drive#approval. - "modifyTime": "A String", # Output only. The most recent time the approval was modified. + "modifyTime": "A String", # The most recent time the approval was modified. "reviewerResponses": [ # The responses made on the approval by reviewers. { # A response on an approval made by a specific reviewer. "kind": "A String", # This is always drive#reviewerResponse. @@ -522,7 +522,7 @@Method Details
}, }, ], - "status": "A String", # Output only. The status of the approval at the time this resource was requested. + "status": "A String", # The status of the approval at the time this resource was requested. "targetFileId": "A String", # Target file id of the approval. }Method Details
{ # Metadata for an approval. An approval is a review or approve process for a Drive item. "approvalId": "A String", # The approval ID. - "completeTime": "A String", # Output only. The time the approval was completed. - "createTime": "A String", # Output only. The time the approval was created. + "completeTime": "A String", # The time the approval was completed. + "createTime": "A String", # The time the approval was created. "dueTime": "A String", # The time that the approval is due. - "fileContentChangeBehavior": "A String", # Output only. The behavior of the approval when the file content changes. + "fileContentChangeBehavior": "A String", # The behavior of the approval when the file content changes. "initiator": { # Information about a Drive user. # The user that requested the approval. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -569,7 +569,7 @@Method Details
"photoLink": "A String", # Output only. A link to the user's profile photo, if available. }, "kind": "A String", # This is always drive#approval. - "modifyTime": "A String", # Output only. The most recent time the approval was modified. + "modifyTime": "A String", # The most recent time the approval was modified. "reviewerResponses": [ # The responses made on the approval by reviewers. { # A response on an approval made by a specific reviewer. "kind": "A String", # This is always drive#reviewerResponse. @@ -584,7 +584,7 @@Method Details
}, }, ], - "status": "A String", # Output only. The status of the approval at the time this resource was requested. + "status": "A String", # The status of the approval at the time this resource was requested. "targetFileId": "A String", # Target file id of the approval. }Method Details
"restrictedSatelliteOk": True or False, # Optional. If set to true, messages will be allowed to be delivered to the app while the device is connected over a restricted satellite network. This should only be enabled for messages that can be handled over a restricted satellite network and only for apps that are enabled to work over a restricted satellite network. Note that the ability of the app to connect to a restricted satellite network is dependent on the carrier's settings and the device model. "ttl": "A String", # How long (in seconds) the message should be kept in FCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks if not set. Set it to 0 if want to send the message immediately. In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s". The ttl will be rounded down to the nearest second. }, + "androidV2": { # Android specific V2 options for messages sent through [FCM connection server](https://goo.gl/4GLdUl). This is a v2 version of the AndroidConfig message and will replace it in the v2 API. # Optional. Input only. Android specific V2 options for messages sent through FCM connection server. Mutually exclusive with `android`. Requests with both `AndroidConfig` and `AndroidConfigV2` will be rejected. + "backgroundSync": { # A Background Sync message that is sent to an Android device. # Optional. Non-urgent background sync message to send to android devices. + }, + "bandwidthConstrainedOk": True or False, # Optional. If set to true, messages will be allowed to be delivered to the app while the device is in bandwidth constrained mode. This should only be enabled when the app has been tested to properly handle messages in bandwidth constrained mode. + "collapseKey": "A String", # An identifier of a group of messages that can be collapsed, so that only the last message gets sent when delivery can be resumed. A maximum of 4 different collapse keys is allowed at any given time. + "data": { # Arbitrary key/value payload. If present, it will override google.firebase.fcm.v1.Message.data. + "a_key": "A String", + }, + "directBootOk": True or False, # Optional. If set to true, messages will be allowed to be delivered to the app while the device is in direct boot mode. See [Support Direct Boot mode](https://developer.android.com/training/articles/direct-boot). + "fcmOptions": { # Options for features provided by the FCM SDK for Android. # Options for features provided by the FCM SDK for Android. If present, it will override google.firebase.fcm.v1.Message.fcm_options. + "analyticsLabel": "A String", # Label associated with the message's analytics data. + }, + "remoteNotification": { # A Remote Notification message that is sent to an Android device. # Optional. User-facing notification to send to android devices. + "mutableContent": True or False, # Optional. If set to true, the notification content can be updated by the app after the notification is received on the device. + "notification": { # Notification v2 to send to android devices. This is a v2 version of the AndroidNotification message and will replace it in the v2 API. # Optional. Notification to send to android devices. + "body": "A String", # The notification's body text. If present, it will override google.firebase.fcm.v1.Notification.body. + "bodyLocArgs": [ # Variable string values to be used in place of the format specifiers in body_loc_key to use to localize the body text to the user's current localization. See [Formatting and Styling](https://goo.gl/MalYE3) for more information. + "A String", + ], + "bodyLocKey": "A String", # The key to the body string in the app's string resources to use to localize the body text to the user's current localization. See [String Resources](https://goo.gl/NdFZGI) for more information. + "channelId": "A String", # The [notification's channel id](https://developer.android.com/guide/topics/ui/notifiers/notifications#ManageChannels) (new in Android O). The app must create a channel with this channel ID before any notification with this channel ID is received. If you don't send this channel ID in the request, or if the channel ID provided has not yet been created by the app, FCM uses the channel ID specified in the app manifest. + "clickAction": "A String", # The action associated with a user click on the notification. If specified, an activity with a matching intent filter is launched when a user clicks on the notification. + "color": "A String", # The notification's icon color, expressed in #rrggbb format. + "defaultLightSettings": True or False, # If set to true, use the Android framework's default LED light settings for the notification. Default values are specified in [config.xml](https://android.googlesource.com/platform/frameworks/base/+/master/core/res/res/values/config.xml). If `default_light_settings` is set to true and `light_settings` is also set, the user-specified `light_settings` is used instead of the default value. + "defaultSound": True or False, # If set to true, use the Android framework's default sound for the notification. Default values are specified in [config.xml](https://android.googlesource.com/platform/frameworks/base/+/master/core/res/res/values/config.xml). + "defaultVibrateTimings": True or False, # If set to true, use the Android framework's default vibrate pattern for the notification. Default values are specified in [config.xml](https://android.googlesource.com/platform/frameworks/base/+/master/core/res/res/values/config.xml). If `default_vibrate_timings` is set to true and `vibrate_timings` is also set, the default value is used instead of the user-specified `vibrate_timings`. + "eventTime": "A String", # Set the time that the event in the notification occurred. Notifications in the panel are sorted by this time. A point in time is represented using [protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/Timestamp). + "icon": "A String", # The notification's icon. Sets the notification icon to myicon for drawable resource myicon. If you don't send this key in the request, FCM displays the launcher icon specified in your app manifest. + "id": 42, # Optional. Identifier used to replace existing notifications in the notification drawer. It is used in conjunction with `tag` to form a unique identifier `(tag, id`)` within the app. If not specified, each request creates a new notification. If specified and a notification with the same `(tag, id)` is already being shown, the new notification replaces the existing one in the notification drawer. + "image": "A String", # Contains the URL of an image that is going to be displayed in a notification. If present, it will override google.firebase.fcm.v1.Notification.image. + "lightSettings": { # Settings to control notification LED. # Settings to control the notification's LED blinking rate and color if LED is available on the device. The total blinking time is controlled by the OS. + "color": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Required. Set `color` of the LED with [google.type.Color](https://github.com/googleapis/googleapis/blob/master/google/type/color.proto). + "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0). + "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1]. + "green": 3.14, # The amount of green in the color as a value in the interval [0, 1]. + "red": 3.14, # The amount of red in the color as a value in the interval [0, 1]. + }, + "lightOffDuration": "A String", # Required. Along with `light_on_duration`, define the blink rate of LED flashes. Resolution defined by [proto.Duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration) + "lightOnDuration": "A String", # Required. Along with `light_off_duration`, define the blink rate of LED flashes. Resolution defined by [proto.Duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration) + }, + "localOnly": True or False, # Set whether or not this notification is relevant only to the current device. Some notifications can be bridged to other devices for remote display, such as a Wear OS watch. This hint can be set to recommend this notification not be bridged. See [Wear OS guides](https://developer.android.com/training/wearables/notifications/bridger#existing-method-of-preventing-bridging) + "notificationCount": 42, # Sets the number of items this notification represents. May be displayed as a badge count for launchers that support badging.See [Notification Badge](https://developer.android.com/training/notify-user/badges). For example, this might be useful if you're using just one notification to represent multiple new messages but you want the count here to represent the number of total new messages. If non-positive or unspecified, systems that support badging use the default, which is to increment a number displayed on the long-press menu each time a new notification arrives. + "notificationPriority": "A String", # Set the relative priority for this notification. Priority is an indication of how much of the user's attention should be consumed by this notification. Low-priority notifications may be hidden from the user in certain situations, while the user might be interrupted for a higher-priority notification. This parameter affects notification priority only on devices running Android 7.1 (API level 25) and lower. On Android 8.0 (API level 26) and higher, priority is ignored in favor of channel [importance](https://developer.android.com/develop/ui/views/notifications/channels#importance). Note this priority differs from `AndroidMessagePriority`. This priority is processed by the client after the message has been delivered, whereas [AndroidMessagePriority](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#androidmessagepriority) is an FCM concept that controls when the message is delivered. + "sound": "A String", # The sound to play when the device receives the notification. Supports "default" or the filename of a sound resource bundled in the app. Sound files must reside in /res/raw/. + "sticky": True or False, # When set to false or unset, the notification is automatically dismissed when the user clicks it in the panel. When set to true, the notification persists even when the user clicks it. + "tag": "A String", # Identifier used to replace existing notifications in the notification drawer. It is used in conjunction with `id` to form a unique identifier `(tag, id`)` within the app. If not specified, each request creates a new notification. If specified and a notification with the same `(tag, id)` is already being shown, the new notification replaces the existing one in the notification drawer. + "ticker": "A String", # Sets the "ticker" text, which is sent to accessibility services. Prior to API level 21 (`Lollipop`), sets the text that is displayed in the status bar when the notification first arrives. + "title": "A String", # The notification's title. If present, it will override google.firebase.fcm.v1.Notification.title. + "titleLocArgs": [ # Variable string values to be used in place of the format specifiers in title_loc_key to use to localize the title text to the user's current localization. See [Formatting and Styling](https://goo.gl/MalYE3) for more information. + "A String", + ], + "titleLocKey": "A String", # The key to the title string in the app's string resources to use to localize the title text to the user's current localization. See [String Resources](https://goo.gl/NdFZGI) for more information. + "vibrateTimings": [ # Set the vibration pattern to use. Pass in an array of [protobuf.Duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration) to turn on or off the vibrator. The first value indicates the `Duration` to wait before turning the vibrator on. The next value indicates the `Duration` to keep the vibrator on. Subsequent values alternate between `Duration` to turn the vibrator off and to turn the vibrator on. If `vibrate_timings` is set and `default_vibrate_timings` is set to `true`, the default value is used instead of the user-specified `vibrate_timings`. + "A String", + ], + "visibility": "A String", # Set the [Notification.visibility](https://developer.android.com/reference/android/app/Notification.html#visibility) of the notification. + }, + "useAsV1DataMessage": True or False, # Optional. If set to true, this RemoteNotification message will be delivered to legacy V1 clients as data messages by omitting the google.firebase.fcm.v1.Message.android_v2.remote_notification.notification. This should only be enabled when migration from legacy V1 data messages. Note that by default (when set to false), RemoteNotification messages are automatically translated to V1 notification message for legacy clients; + }, + "restrictedPackageName": "A String", # Package name of the application where the registration token must match in order to receive the message. + "restrictedSatelliteOk": True or False, # Optional. If set to true, messages will be allowed to be delivered to the app while the device is connected over a restricted satellite network. This should only be enabled for messages that can be handled over a restricted satellite network and only for apps that are enabled to work over a restricted satellite network. Note that the ability of the app to connect to a restricted satellite network is dependent on the carrier's settings and the device model. + "ttl": "A String", # How long (in seconds) the message should be kept in FCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks if not set. Set it to 0 if want to send the message immediately. In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s". The ttl will be rounded down to the nearest second. + }, "apns": { # [Apple Push Notification Service](https://goo.gl/MXRTPa) specific options. # Input only. [Apple Push Notification Service](https://goo.gl/MXRTPa) specific options. "fcmOptions": { # Options for features provided by the FCM SDK for iOS. # Options for features provided by the FCM SDK for iOS. "analyticsLabel": "A String", # Label associated with the message's analytics data. @@ -272,6 +335,69 @@Method Details
"restrictedSatelliteOk": True or False, # Optional. If set to true, messages will be allowed to be delivered to the app while the device is connected over a restricted satellite network. This should only be enabled for messages that can be handled over a restricted satellite network and only for apps that are enabled to work over a restricted satellite network. Note that the ability of the app to connect to a restricted satellite network is dependent on the carrier's settings and the device model. "ttl": "A String", # How long (in seconds) the message should be kept in FCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks if not set. Set it to 0 if want to send the message immediately. In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s". The ttl will be rounded down to the nearest second. }, + "androidV2": { # Android specific V2 options for messages sent through [FCM connection server](https://goo.gl/4GLdUl). This is a v2 version of the AndroidConfig message and will replace it in the v2 API. # Optional. Input only. Android specific V2 options for messages sent through FCM connection server. Mutually exclusive with `android`. Requests with both `AndroidConfig` and `AndroidConfigV2` will be rejected. + "backgroundSync": { # A Background Sync message that is sent to an Android device. # Optional. Non-urgent background sync message to send to android devices. + }, + "bandwidthConstrainedOk": True or False, # Optional. If set to true, messages will be allowed to be delivered to the app while the device is in bandwidth constrained mode. This should only be enabled when the app has been tested to properly handle messages in bandwidth constrained mode. + "collapseKey": "A String", # An identifier of a group of messages that can be collapsed, so that only the last message gets sent when delivery can be resumed. A maximum of 4 different collapse keys is allowed at any given time. + "data": { # Arbitrary key/value payload. If present, it will override google.firebase.fcm.v1.Message.data. + "a_key": "A String", + }, + "directBootOk": True or False, # Optional. If set to true, messages will be allowed to be delivered to the app while the device is in direct boot mode. See [Support Direct Boot mode](https://developer.android.com/training/articles/direct-boot). + "fcmOptions": { # Options for features provided by the FCM SDK for Android. # Options for features provided by the FCM SDK for Android. If present, it will override google.firebase.fcm.v1.Message.fcm_options. + "analyticsLabel": "A String", # Label associated with the message's analytics data. + }, + "remoteNotification": { # A Remote Notification message that is sent to an Android device. # Optional. User-facing notification to send to android devices. + "mutableContent": True or False, # Optional. If set to true, the notification content can be updated by the app after the notification is received on the device. + "notification": { # Notification v2 to send to android devices. This is a v2 version of the AndroidNotification message and will replace it in the v2 API. # Optional. Notification to send to android devices. + "body": "A String", # The notification's body text. If present, it will override google.firebase.fcm.v1.Notification.body. + "bodyLocArgs": [ # Variable string values to be used in place of the format specifiers in body_loc_key to use to localize the body text to the user's current localization. See [Formatting and Styling](https://goo.gl/MalYE3) for more information. + "A String", + ], + "bodyLocKey": "A String", # The key to the body string in the app's string resources to use to localize the body text to the user's current localization. See [String Resources](https://goo.gl/NdFZGI) for more information. + "channelId": "A String", # The [notification's channel id](https://developer.android.com/guide/topics/ui/notifiers/notifications#ManageChannels) (new in Android O). The app must create a channel with this channel ID before any notification with this channel ID is received. If you don't send this channel ID in the request, or if the channel ID provided has not yet been created by the app, FCM uses the channel ID specified in the app manifest. + "clickAction": "A String", # The action associated with a user click on the notification. If specified, an activity with a matching intent filter is launched when a user clicks on the notification. + "color": "A String", # The notification's icon color, expressed in #rrggbb format. + "defaultLightSettings": True or False, # If set to true, use the Android framework's default LED light settings for the notification. Default values are specified in [config.xml](https://android.googlesource.com/platform/frameworks/base/+/master/core/res/res/values/config.xml). If `default_light_settings` is set to true and `light_settings` is also set, the user-specified `light_settings` is used instead of the default value. + "defaultSound": True or False, # If set to true, use the Android framework's default sound for the notification. Default values are specified in [config.xml](https://android.googlesource.com/platform/frameworks/base/+/master/core/res/res/values/config.xml). + "defaultVibrateTimings": True or False, # If set to true, use the Android framework's default vibrate pattern for the notification. Default values are specified in [config.xml](https://android.googlesource.com/platform/frameworks/base/+/master/core/res/res/values/config.xml). If `default_vibrate_timings` is set to true and `vibrate_timings` is also set, the default value is used instead of the user-specified `vibrate_timings`. + "eventTime": "A String", # Set the time that the event in the notification occurred. Notifications in the panel are sorted by this time. A point in time is represented using [protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/Timestamp). + "icon": "A String", # The notification's icon. Sets the notification icon to myicon for drawable resource myicon. If you don't send this key in the request, FCM displays the launcher icon specified in your app manifest. + "id": 42, # Optional. Identifier used to replace existing notifications in the notification drawer. It is used in conjunction with `tag` to form a unique identifier `(tag, id`)` within the app. If not specified, each request creates a new notification. If specified and a notification with the same `(tag, id)` is already being shown, the new notification replaces the existing one in the notification drawer. + "image": "A String", # Contains the URL of an image that is going to be displayed in a notification. If present, it will override google.firebase.fcm.v1.Notification.image. + "lightSettings": { # Settings to control notification LED. # Settings to control the notification's LED blinking rate and color if LED is available on the device. The total blinking time is controlled by the OS. + "color": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Required. Set `color` of the LED with [google.type.Color](https://github.com/googleapis/googleapis/blob/master/google/type/color.proto). + "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0). + "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1]. + "green": 3.14, # The amount of green in the color as a value in the interval [0, 1]. + "red": 3.14, # The amount of red in the color as a value in the interval [0, 1]. + }, + "lightOffDuration": "A String", # Required. Along with `light_on_duration`, define the blink rate of LED flashes. Resolution defined by [proto.Duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration) + "lightOnDuration": "A String", # Required. Along with `light_off_duration`, define the blink rate of LED flashes. Resolution defined by [proto.Duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration) + }, + "localOnly": True or False, # Set whether or not this notification is relevant only to the current device. Some notifications can be bridged to other devices for remote display, such as a Wear OS watch. This hint can be set to recommend this notification not be bridged. See [Wear OS guides](https://developer.android.com/training/wearables/notifications/bridger#existing-method-of-preventing-bridging) + "notificationCount": 42, # Sets the number of items this notification represents. May be displayed as a badge count for launchers that support badging.See [Notification Badge](https://developer.android.com/training/notify-user/badges). For example, this might be useful if you're using just one notification to represent multiple new messages but you want the count here to represent the number of total new messages. If non-positive or unspecified, systems that support badging use the default, which is to increment a number displayed on the long-press menu each time a new notification arrives. + "notificationPriority": "A String", # Set the relative priority for this notification. Priority is an indication of how much of the user's attention should be consumed by this notification. Low-priority notifications may be hidden from the user in certain situations, while the user might be interrupted for a higher-priority notification. This parameter affects notification priority only on devices running Android 7.1 (API level 25) and lower. On Android 8.0 (API level 26) and higher, priority is ignored in favor of channel [importance](https://developer.android.com/develop/ui/views/notifications/channels#importance). Note this priority differs from `AndroidMessagePriority`. This priority is processed by the client after the message has been delivered, whereas [AndroidMessagePriority](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#androidmessagepriority) is an FCM concept that controls when the message is delivered. + "sound": "A String", # The sound to play when the device receives the notification. Supports "default" or the filename of a sound resource bundled in the app. Sound files must reside in /res/raw/. + "sticky": True or False, # When set to false or unset, the notification is automatically dismissed when the user clicks it in the panel. When set to true, the notification persists even when the user clicks it. + "tag": "A String", # Identifier used to replace existing notifications in the notification drawer. It is used in conjunction with `id` to form a unique identifier `(tag, id`)` within the app. If not specified, each request creates a new notification. If specified and a notification with the same `(tag, id)` is already being shown, the new notification replaces the existing one in the notification drawer. + "ticker": "A String", # Sets the "ticker" text, which is sent to accessibility services. Prior to API level 21 (`Lollipop`), sets the text that is displayed in the status bar when the notification first arrives. + "title": "A String", # The notification's title. If present, it will override google.firebase.fcm.v1.Notification.title. + "titleLocArgs": [ # Variable string values to be used in place of the format specifiers in title_loc_key to use to localize the title text to the user's current localization. See [Formatting and Styling](https://goo.gl/MalYE3) for more information. + "A String", + ], + "titleLocKey": "A String", # The key to the title string in the app's string resources to use to localize the title text to the user's current localization. See [String Resources](https://goo.gl/NdFZGI) for more information. + "vibrateTimings": [ # Set the vibration pattern to use. Pass in an array of [protobuf.Duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration) to turn on or off the vibrator. The first value indicates the `Duration` to wait before turning the vibrator on. The next value indicates the `Duration` to keep the vibrator on. Subsequent values alternate between `Duration` to turn the vibrator off and to turn the vibrator on. If `vibrate_timings` is set and `default_vibrate_timings` is set to `true`, the default value is used instead of the user-specified `vibrate_timings`. + "A String", + ], + "visibility": "A String", # Set the [Notification.visibility](https://developer.android.com/reference/android/app/Notification.html#visibility) of the notification. + }, + "useAsV1DataMessage": True or False, # Optional. If set to true, this RemoteNotification message will be delivered to legacy V1 clients as data messages by omitting the google.firebase.fcm.v1.Message.android_v2.remote_notification.notification. This should only be enabled when migration from legacy V1 data messages. Note that by default (when set to false), RemoteNotification messages are automatically translated to V1 notification message for legacy clients; + }, + "restrictedPackageName": "A String", # Package name of the application where the registration token must match in order to receive the message. + "restrictedSatelliteOk": True or False, # Optional. If set to true, messages will be allowed to be delivered to the app while the device is connected over a restricted satellite network. This should only be enabled for messages that can be handled over a restricted satellite network and only for apps that are enabled to work over a restricted satellite network. Note that the ability of the app to connect to a restricted satellite network is dependent on the carrier's settings and the device model. + "ttl": "A String", # How long (in seconds) the message should be kept in FCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks if not set. Set it to 0 if want to send the message immediately. In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s". The ttl will be rounded down to the nearest second. + }, "apns": { # [Apple Push Notification Service](https://goo.gl/MXRTPa) specific options. # Input only. [Apple Push Notification Service](https://goo.gl/MXRTPa) specific options. "fcmOptions": { # Options for features provided by the FCM SDK for iOS. # Options for features provided by the FCM SDK for iOS. "analyticsLabel": "A String", # Label associated with the message's analytics data. diff --git a/docs/dyn/file_v1beta1.projects.locations.instances.html b/docs/dyn/file_v1beta1.projects.locations.instances.html index dc6f2e137b..207431d836 100644 --- a/docs/dyn/file_v1beta1.projects.locations.instances.html +++ b/docs/dyn/file_v1beta1.projects.locations.instances.html @@ -179,7 +179,7 @@Method Details
}, ], "restoreConfig": { # Optional configuration for restore backup operations. # Optional. Input only. Specifies options for restoring from a backup source. Use this field to configure a partial restore, allowing recovery of specific files or directories instead of the entire backup. This field is only valid if the source oneof is set to `source_backup` or `source_backupdr_backup`. If this field is not provided, restoring from a backup will perform a full restore. - "pathPatterns": [ # Optional. Example: If you want to restore `/mnt/share/dir1/file.txt`, the path pattern must be `/dir1/file.txt`. If you want to restore `/mnt/share/dir1/`, the path pattern must be `/dir1`. Currently only single path is supported, Glob patterns are not supported. + "pathPatterns": [ # Optional. A collection of paths/patterns to restore from the backup. If empty, a full restore is performed. A valid path is relative to the file share's mount point and must not include a trailing slash. The path must start with a leading `/`. Example: If you want to restore `/mnt/share/dir1/file.txt`, the path pattern must be `/dir1/file.txt`. If you want to restore `/mnt/share/dir1/`, the path pattern must be `/dir1`. Currently only single path is supported, Glob patterns are not supported. "A String", ], }, @@ -380,7 +380,7 @@Method Details
}, ], "restoreConfig": { # Optional configuration for restore backup operations. # Optional. Input only. Specifies options for restoring from a backup source. Use this field to configure a partial restore, allowing recovery of specific files or directories instead of the entire backup. This field is only valid if the source oneof is set to `source_backup` or `source_backupdr_backup`. If this field is not provided, restoring from a backup will perform a full restore. - "pathPatterns": [ # Optional. Example: If you want to restore `/mnt/share/dir1/file.txt`, the path pattern must be `/dir1/file.txt`. If you want to restore `/mnt/share/dir1/`, the path pattern must be `/dir1`. Currently only single path is supported, Glob patterns are not supported. + "pathPatterns": [ # Optional. A collection of paths/patterns to restore from the backup. If empty, a full restore is performed. A valid path is relative to the file share's mount point and must not include a trailing slash. The path must start with a leading `/`. Example: If you want to restore `/mnt/share/dir1/file.txt`, the path pattern must be `/dir1/file.txt`. If you want to restore `/mnt/share/dir1/`, the path pattern must be `/dir1`. Currently only single path is supported, Glob patterns are not supported. "A String", ], }, @@ -522,7 +522,7 @@Method Details
}, ], "restoreConfig": { # Optional configuration for restore backup operations. # Optional. Input only. Specifies options for restoring from a backup source. Use this field to configure a partial restore, allowing recovery of specific files or directories instead of the entire backup. This field is only valid if the source oneof is set to `source_backup` or `source_backupdr_backup`. If this field is not provided, restoring from a backup will perform a full restore. - "pathPatterns": [ # Optional. Example: If you want to restore `/mnt/share/dir1/file.txt`, the path pattern must be `/dir1/file.txt`. If you want to restore `/mnt/share/dir1/`, the path pattern must be `/dir1`. Currently only single path is supported, Glob patterns are not supported. + "pathPatterns": [ # Optional. A collection of paths/patterns to restore from the backup. If empty, a full restore is performed. A valid path is relative to the file share's mount point and must not include a trailing slash. The path must start with a leading `/`. Example: If you want to restore `/mnt/share/dir1/file.txt`, the path pattern must be `/dir1/file.txt`. If you want to restore `/mnt/share/dir1/`, the path pattern must be `/dir1`. Currently only single path is supported, Glob patterns are not supported. "A String", ], }, @@ -673,7 +673,7 @@Method Details
}, ], "restoreConfig": { # Optional configuration for restore backup operations. # Optional. Input only. Specifies options for restoring from a backup source. Use this field to configure a partial restore, allowing recovery of specific files or directories instead of the entire backup. This field is only valid if the source oneof is set to `source_backup` or `source_backupdr_backup`. If this field is not provided, restoring from a backup will perform a full restore. - "pathPatterns": [ # Optional. Example: If you want to restore `/mnt/share/dir1/file.txt`, the path pattern must be `/dir1/file.txt`. If you want to restore `/mnt/share/dir1/`, the path pattern must be `/dir1`. Currently only single path is supported, Glob patterns are not supported. + "pathPatterns": [ # Optional. A collection of paths/patterns to restore from the backup. If empty, a full restore is performed. A valid path is relative to the file share's mount point and must not include a trailing slash. The path must start with a leading `/`. Example: If you want to restore `/mnt/share/dir1/file.txt`, the path pattern must be `/dir1/file.txt`. If you want to restore `/mnt/share/dir1/`, the path pattern must be `/dir1`. Currently only single path is supported, Glob patterns are not supported. "A String", ], }, diff --git a/docs/dyn/file_v1beta1.projects.locations.volumePools.volumes.html b/docs/dyn/file_v1beta1.projects.locations.volumePools.volumes.html index 035f625be4..5e0a171123 100644 --- a/docs/dyn/file_v1beta1.projects.locations.volumePools.volumes.html +++ b/docs/dyn/file_v1beta1.projects.locations.volumePools.volumes.html @@ -219,6 +219,7 @@Method Details
}, ], "quota": "A String", # Optional. The limit for how much data can be written to this volume, in MiB. + "requestId": "A String", # Optional. A unique ID used to identify the request, so retries are idempotent. Must be a valid UUID4; the zero UUID (`00000000-0000-0000-0000-000000000000`) is not supported. "volumeId": "A String", # Required. Unique identifier for the volume which also appears in the volumes resource name. } @@ -593,6 +594,7 @@Method Details
}, ], "quota": "A String", # Optional. The limit for how much data can be written to this volume, in MiB. + "requestId": "A String", # Optional. A unique ID used to identify the request, so retries are idempotent. Must be a valid UUID4; the zero UUID (`00000000-0000-0000-0000-000000000000`) is not supported. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/firebaseappcheck_v1beta.projects.services.automations.html b/docs/dyn/firebaseappcheck_v1beta.projects.services.automations.html new file mode 100644 index 0000000000..471e8a6709 --- /dev/null +++ b/docs/dyn/firebaseappcheck_v1beta.projects.services.automations.html @@ -0,0 +1,208 @@ + + + +Firebase App Check API . projects . services . automations
+Instance Methods
++
+close()Close httplib2 connections.
+ +Gets the specified Automation configuration.
++
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)Lists all Automations for the specified service or resource policy.
++
+list_next(previous_request, previous_response)Retrieves the next page of results.
++
+patch(name, body=None, updateMask=None, x__xgafv=None)Updates the specified Automation.
+Method Details
+++ +close()+Close httplib2 connections.+++ +get(name, x__xgafv=None)+Gets the specified Automation configuration. + +Args: + name: string, Required. The relative resource name of the Automation to retrieve, in one of the following supported formats: ``` projects/{project_number}/services/{service_id}/automations/{automation_id} projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id}/automations/{automation_id} ``` (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An **enforcement automation** is useful for automatically enforcing a service or a resource policy within a service when a certain condition is met. For example, you may create an automation that automatically turns on enforcement for your Cloud Firestore service at a specified timestamp in the future. For your security, an automation object may be created by the system in order to protect sensitive services by default. These *system-created* automations can be opted out, if you so choose, by calling the SuspendAutomation method on them. Suspending a system-created automation is not recommended, but is supported for advanced use cases. The system will not execute nor modify any suspended automations. Also, system-created automations **cannot** be deleted, but can be freely modified, which is also not recommended, as the system may later overwrite your changes with its own default settings without notice (assuming it has not been suspended). An automation's condition is evaluated periodically; the frequency of this periodic evaluation depends on the exact condition. While the details are unspecified, evaluations will be conducted reasonably frequently so that a satisfied condition will be detected in a timely fashion. Once a condition has been detected to be satisfied, the enforcement action will be executed immediately. Currently, the only enforcement action supported is to **enforce** App Check protections on the associated parent service or parent resource policy. Once executed, the automation becomes immutable, and serves as a historical record of that execution. Its `update_time` field will be populated with the timestamp at which the execution occurred, and its `state` field will be set to `SUCCEEDED`. Successful automations not created by the system can still be deleted. If, during the evaluation or execution of an automation, App Check discovers that it is no longer possible for the service or resource to receive App Check protection, App Check may suspend your automation without warning. For example, if you have disabled a service, or have deleted all resources within a service, and that service does not support storing your App Check preferences while it is in such a state, then an automation created for this service may be suspended. Please ensure that the service or resource is correctly configured and operating normally throughout the lifetime of the automation to avoid suspension. + "createTime": "A String", # Output only. Timestamp at which this automation object was created. + "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. + "name": "A String", # Identifier. The relative resource name of the automation object, in one of the following supported formats: ``` projects/{project_number}/services/{service_id}/automations/{automation_id} projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id}/automations/{automation_id} ``` + "origin": "A String", # Output only. The original creator of this automation object. + "state": "A String", # Output only. The state that this automation object is currently in. + "triggerTime": "A String", # A condition that is satisfied if the current time is greater than or equal to the specified timestamp. + "updateTime": "A String", # Output only. Timestamp at which this automation object was most recently updated, either by the system or by the user. If this automation has already been executed, this field indicates the exact timestamp at which it was executed. +}+++ +list(parent, pageSize=None, pageToken=None, x__xgafv=None)+Lists all Automations for the specified service or resource policy. + +Args: + parent: string, Required. The relative resource name of the parent service or resource policy for which to list each associated Automation, in one of the following formats: ``` projects/{project_number}/services/{service_id} projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` (required) + pageSize: integer, The maximum number of Automations to return in the response. Note that a service or resource policy can have at most 10 automations. The server may return fewer than this at its own discretion. If no value is specified (or too large a value is specified), the server will impose its own limit. + pageToken: string, Token returned from a previous call to ListAutomations indicating where in the set of Automations to resume listing. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAutomations must match the call that provided the page token; if they do not match, the result is undefined. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response message for the ListAutomations method. + "automations": [ # The Automations retrieved. + { # An **enforcement automation** is useful for automatically enforcing a service or a resource policy within a service when a certain condition is met. For example, you may create an automation that automatically turns on enforcement for your Cloud Firestore service at a specified timestamp in the future. For your security, an automation object may be created by the system in order to protect sensitive services by default. These *system-created* automations can be opted out, if you so choose, by calling the SuspendAutomation method on them. Suspending a system-created automation is not recommended, but is supported for advanced use cases. The system will not execute nor modify any suspended automations. Also, system-created automations **cannot** be deleted, but can be freely modified, which is also not recommended, as the system may later overwrite your changes with its own default settings without notice (assuming it has not been suspended). An automation's condition is evaluated periodically; the frequency of this periodic evaluation depends on the exact condition. While the details are unspecified, evaluations will be conducted reasonably frequently so that a satisfied condition will be detected in a timely fashion. Once a condition has been detected to be satisfied, the enforcement action will be executed immediately. Currently, the only enforcement action supported is to **enforce** App Check protections on the associated parent service or parent resource policy. Once executed, the automation becomes immutable, and serves as a historical record of that execution. Its `update_time` field will be populated with the timestamp at which the execution occurred, and its `state` field will be set to `SUCCEEDED`. Successful automations not created by the system can still be deleted. If, during the evaluation or execution of an automation, App Check discovers that it is no longer possible for the service or resource to receive App Check protection, App Check may suspend your automation without warning. For example, if you have disabled a service, or have deleted all resources within a service, and that service does not support storing your App Check preferences while it is in such a state, then an automation created for this service may be suspended. Please ensure that the service or resource is correctly configured and operating normally throughout the lifetime of the automation to avoid suspension. + "createTime": "A String", # Output only. Timestamp at which this automation object was created. + "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. + "name": "A String", # Identifier. The relative resource name of the automation object, in one of the following supported formats: ``` projects/{project_number}/services/{service_id}/automations/{automation_id} projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id}/automations/{automation_id} ``` + "origin": "A String", # Output only. The original creator of this automation object. + "state": "A String", # Output only. The state that this automation object is currently in. + "triggerTime": "A String", # A condition that is satisfied if the current time is greater than or equal to the specified timestamp. + "updateTime": "A String", # Output only. Timestamp at which this automation object was most recently updated, either by the system or by the user. If this automation has already been executed, this field indicates the exact timestamp at which it was executed. + }, + ], + "nextPageToken": "A String", # If the result list is too large to fit in a single response, then a token is returned. If the string is empty or omitted, then this response is the last page of results. This token can be used in a subsequent call to ListAutomations to find the next group of Automations. Page tokens are short-lived and should not be persisted. +}+++ +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/firebaseappcheck_v1beta.projects.services.html b/docs/dyn/firebaseappcheck_v1beta.projects.services.html index 030cf70990..10b7ad6daa 100644 --- a/docs/dyn/firebaseappcheck_v1beta.projects.services.html +++ b/docs/dyn/firebaseappcheck_v1beta.projects.services.html @@ -74,6 +74,11 @@patch(name, body=None, updateMask=None, x__xgafv=None)+Updates the specified Automation. + +Args: + name: string, Identifier. The relative resource name of the automation object, in one of the following supported formats: ``` projects/{project_number}/services/{service_id}/automations/{automation_id} projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id}/automations/{automation_id} ``` (required) + body: object, The request body. + The object takes the form of: + +{ # An **enforcement automation** is useful for automatically enforcing a service or a resource policy within a service when a certain condition is met. For example, you may create an automation that automatically turns on enforcement for your Cloud Firestore service at a specified timestamp in the future. For your security, an automation object may be created by the system in order to protect sensitive services by default. These *system-created* automations can be opted out, if you so choose, by calling the SuspendAutomation method on them. Suspending a system-created automation is not recommended, but is supported for advanced use cases. The system will not execute nor modify any suspended automations. Also, system-created automations **cannot** be deleted, but can be freely modified, which is also not recommended, as the system may later overwrite your changes with its own default settings without notice (assuming it has not been suspended). An automation's condition is evaluated periodically; the frequency of this periodic evaluation depends on the exact condition. While the details are unspecified, evaluations will be conducted reasonably frequently so that a satisfied condition will be detected in a timely fashion. Once a condition has been detected to be satisfied, the enforcement action will be executed immediately. Currently, the only enforcement action supported is to **enforce** App Check protections on the associated parent service or parent resource policy. Once executed, the automation becomes immutable, and serves as a historical record of that execution. Its `update_time` field will be populated with the timestamp at which the execution occurred, and its `state` field will be set to `SUCCEEDED`. Successful automations not created by the system can still be deleted. If, during the evaluation or execution of an automation, App Check discovers that it is no longer possible for the service or resource to receive App Check protection, App Check may suspend your automation without warning. For example, if you have disabled a service, or have deleted all resources within a service, and that service does not support storing your App Check preferences while it is in such a state, then an automation created for this service may be suspended. Please ensure that the service or resource is correctly configured and operating normally throughout the lifetime of the automation to avoid suspension. + "createTime": "A String", # Output only. Timestamp at which this automation object was created. + "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. + "name": "A String", # Identifier. The relative resource name of the automation object, in one of the following supported formats: ``` projects/{project_number}/services/{service_id}/automations/{automation_id} projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id}/automations/{automation_id} ``` + "origin": "A String", # Output only. The original creator of this automation object. + "state": "A String", # Output only. The state that this automation object is currently in. + "triggerTime": "A String", # A condition that is satisfied if the current time is greater than or equal to the specified timestamp. + "updateTime": "A String", # Output only. Timestamp at which this automation object was most recently updated, either by the system or by the user. If this automation has already been executed, this field indicates the exact timestamp at which it was executed. +} + + updateMask: string, Required. A comma-separated list of names of fields in the Automation to update. Example: `timestamp_condition.enforce_time`. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An **enforcement automation** is useful for automatically enforcing a service or a resource policy within a service when a certain condition is met. For example, you may create an automation that automatically turns on enforcement for your Cloud Firestore service at a specified timestamp in the future. For your security, an automation object may be created by the system in order to protect sensitive services by default. These *system-created* automations can be opted out, if you so choose, by calling the SuspendAutomation method on them. Suspending a system-created automation is not recommended, but is supported for advanced use cases. The system will not execute nor modify any suspended automations. Also, system-created automations **cannot** be deleted, but can be freely modified, which is also not recommended, as the system may later overwrite your changes with its own default settings without notice (assuming it has not been suspended). An automation's condition is evaluated periodically; the frequency of this periodic evaluation depends on the exact condition. While the details are unspecified, evaluations will be conducted reasonably frequently so that a satisfied condition will be detected in a timely fashion. Once a condition has been detected to be satisfied, the enforcement action will be executed immediately. Currently, the only enforcement action supported is to **enforce** App Check protections on the associated parent service or parent resource policy. Once executed, the automation becomes immutable, and serves as a historical record of that execution. Its `update_time` field will be populated with the timestamp at which the execution occurred, and its `state` field will be set to `SUCCEEDED`. Successful automations not created by the system can still be deleted. If, during the evaluation or execution of an automation, App Check discovers that it is no longer possible for the service or resource to receive App Check protection, App Check may suspend your automation without warning. For example, if you have disabled a service, or have deleted all resources within a service, and that service does not support storing your App Check preferences while it is in such a state, then an automation created for this service may be suspended. Please ensure that the service or resource is correctly configured and operating normally throughout the lifetime of the automation to avoid suspension. + "createTime": "A String", # Output only. Timestamp at which this automation object was created. + "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. + "name": "A String", # Identifier. The relative resource name of the automation object, in one of the following supported formats: ``` projects/{project_number}/services/{service_id}/automations/{automation_id} projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id}/automations/{automation_id} ``` + "origin": "A String", # Output only. The original creator of this automation object. + "state": "A String", # Output only. The state that this automation object is currently in. + "triggerTime": "A String", # A condition that is satisfied if the current time is greater than or equal to the specified timestamp. + "updateTime": "A String", # Output only. Timestamp at which this automation object was most recently updated, either by the system or by the user. If this automation has already been executed, this field indicates the exact timestamp at which it was executed. +}+Firebase App Check API . projects . services
Instance Methods
++
+automations()+Returns the automations Resource.
+ diff --git a/docs/dyn/firebaseappcheck_v1beta.projects.services.resourcePolicies.automations.html b/docs/dyn/firebaseappcheck_v1beta.projects.services.resourcePolicies.automations.html new file mode 100644 index 0000000000..be7833278d --- /dev/null +++ b/docs/dyn/firebaseappcheck_v1beta.projects.services.resourcePolicies.automations.html @@ -0,0 +1,208 @@ + + + +Firebase App Check API . projects . services . resourcePolicies . automations
+Instance Methods
++
+close()Close httplib2 connections.
+ +Gets the specified Automation configuration.
++
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)Lists all Automations for the specified service or resource policy.
++
+list_next(previous_request, previous_response)Retrieves the next page of results.
++
+patch(name, body=None, updateMask=None, x__xgafv=None)Updates the specified Automation.
+Method Details
+++ +close()+Close httplib2 connections.+++ +get(name, x__xgafv=None)+Gets the specified Automation configuration. + +Args: + name: string, Required. The relative resource name of the Automation to retrieve, in one of the following supported formats: ``` projects/{project_number}/services/{service_id}/automations/{automation_id} projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id}/automations/{automation_id} ``` (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An **enforcement automation** is useful for automatically enforcing a service or a resource policy within a service when a certain condition is met. For example, you may create an automation that automatically turns on enforcement for your Cloud Firestore service at a specified timestamp in the future. For your security, an automation object may be created by the system in order to protect sensitive services by default. These *system-created* automations can be opted out, if you so choose, by calling the SuspendAutomation method on them. Suspending a system-created automation is not recommended, but is supported for advanced use cases. The system will not execute nor modify any suspended automations. Also, system-created automations **cannot** be deleted, but can be freely modified, which is also not recommended, as the system may later overwrite your changes with its own default settings without notice (assuming it has not been suspended). An automation's condition is evaluated periodically; the frequency of this periodic evaluation depends on the exact condition. While the details are unspecified, evaluations will be conducted reasonably frequently so that a satisfied condition will be detected in a timely fashion. Once a condition has been detected to be satisfied, the enforcement action will be executed immediately. Currently, the only enforcement action supported is to **enforce** App Check protections on the associated parent service or parent resource policy. Once executed, the automation becomes immutable, and serves as a historical record of that execution. Its `update_time` field will be populated with the timestamp at which the execution occurred, and its `state` field will be set to `SUCCEEDED`. Successful automations not created by the system can still be deleted. If, during the evaluation or execution of an automation, App Check discovers that it is no longer possible for the service or resource to receive App Check protection, App Check may suspend your automation without warning. For example, if you have disabled a service, or have deleted all resources within a service, and that service does not support storing your App Check preferences while it is in such a state, then an automation created for this service may be suspended. Please ensure that the service or resource is correctly configured and operating normally throughout the lifetime of the automation to avoid suspension. + "createTime": "A String", # Output only. Timestamp at which this automation object was created. + "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. + "name": "A String", # Identifier. The relative resource name of the automation object, in one of the following supported formats: ``` projects/{project_number}/services/{service_id}/automations/{automation_id} projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id}/automations/{automation_id} ``` + "origin": "A String", # Output only. The original creator of this automation object. + "state": "A String", # Output only. The state that this automation object is currently in. + "triggerTime": "A String", # A condition that is satisfied if the current time is greater than or equal to the specified timestamp. + "updateTime": "A String", # Output only. Timestamp at which this automation object was most recently updated, either by the system or by the user. If this automation has already been executed, this field indicates the exact timestamp at which it was executed. +}+++ +list(parent, pageSize=None, pageToken=None, x__xgafv=None)+Lists all Automations for the specified service or resource policy. + +Args: + parent: string, Required. The relative resource name of the parent service or resource policy for which to list each associated Automation, in one of the following formats: ``` projects/{project_number}/services/{service_id} projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` (required) + pageSize: integer, The maximum number of Automations to return in the response. Note that a service or resource policy can have at most 10 automations. The server may return fewer than this at its own discretion. If no value is specified (or too large a value is specified), the server will impose its own limit. + pageToken: string, Token returned from a previous call to ListAutomations indicating where in the set of Automations to resume listing. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAutomations must match the call that provided the page token; if they do not match, the result is undefined. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response message for the ListAutomations method. + "automations": [ # The Automations retrieved. + { # An **enforcement automation** is useful for automatically enforcing a service or a resource policy within a service when a certain condition is met. For example, you may create an automation that automatically turns on enforcement for your Cloud Firestore service at a specified timestamp in the future. For your security, an automation object may be created by the system in order to protect sensitive services by default. These *system-created* automations can be opted out, if you so choose, by calling the SuspendAutomation method on them. Suspending a system-created automation is not recommended, but is supported for advanced use cases. The system will not execute nor modify any suspended automations. Also, system-created automations **cannot** be deleted, but can be freely modified, which is also not recommended, as the system may later overwrite your changes with its own default settings without notice (assuming it has not been suspended). An automation's condition is evaluated periodically; the frequency of this periodic evaluation depends on the exact condition. While the details are unspecified, evaluations will be conducted reasonably frequently so that a satisfied condition will be detected in a timely fashion. Once a condition has been detected to be satisfied, the enforcement action will be executed immediately. Currently, the only enforcement action supported is to **enforce** App Check protections on the associated parent service or parent resource policy. Once executed, the automation becomes immutable, and serves as a historical record of that execution. Its `update_time` field will be populated with the timestamp at which the execution occurred, and its `state` field will be set to `SUCCEEDED`. Successful automations not created by the system can still be deleted. If, during the evaluation or execution of an automation, App Check discovers that it is no longer possible for the service or resource to receive App Check protection, App Check may suspend your automation without warning. For example, if you have disabled a service, or have deleted all resources within a service, and that service does not support storing your App Check preferences while it is in such a state, then an automation created for this service may be suspended. Please ensure that the service or resource is correctly configured and operating normally throughout the lifetime of the automation to avoid suspension. + "createTime": "A String", # Output only. Timestamp at which this automation object was created. + "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. + "name": "A String", # Identifier. The relative resource name of the automation object, in one of the following supported formats: ``` projects/{project_number}/services/{service_id}/automations/{automation_id} projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id}/automations/{automation_id} ``` + "origin": "A String", # Output only. The original creator of this automation object. + "state": "A String", # Output only. The state that this automation object is currently in. + "triggerTime": "A String", # A condition that is satisfied if the current time is greater than or equal to the specified timestamp. + "updateTime": "A String", # Output only. Timestamp at which this automation object was most recently updated, either by the system or by the user. If this automation has already been executed, this field indicates the exact timestamp at which it was executed. + }, + ], + "nextPageToken": "A String", # If the result list is too large to fit in a single response, then a token is returned. If the string is empty or omitted, then this response is the last page of results. This token can be used in a subsequent call to ListAutomations to find the next group of Automations. Page tokens are short-lived and should not be persisted. +}+++ +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/firebaseappcheck_v1beta.projects.services.resourcePolicies.html b/docs/dyn/firebaseappcheck_v1beta.projects.services.resourcePolicies.html index b5b25b03d3..8297f800db 100644 --- a/docs/dyn/firebaseappcheck_v1beta.projects.services.resourcePolicies.html +++ b/docs/dyn/firebaseappcheck_v1beta.projects.services.resourcePolicies.html @@ -74,6 +74,11 @@patch(name, body=None, updateMask=None, x__xgafv=None)+Updates the specified Automation. + +Args: + name: string, Identifier. The relative resource name of the automation object, in one of the following supported formats: ``` projects/{project_number}/services/{service_id}/automations/{automation_id} projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id}/automations/{automation_id} ``` (required) + body: object, The request body. + The object takes the form of: + +{ # An **enforcement automation** is useful for automatically enforcing a service or a resource policy within a service when a certain condition is met. For example, you may create an automation that automatically turns on enforcement for your Cloud Firestore service at a specified timestamp in the future. For your security, an automation object may be created by the system in order to protect sensitive services by default. These *system-created* automations can be opted out, if you so choose, by calling the SuspendAutomation method on them. Suspending a system-created automation is not recommended, but is supported for advanced use cases. The system will not execute nor modify any suspended automations. Also, system-created automations **cannot** be deleted, but can be freely modified, which is also not recommended, as the system may later overwrite your changes with its own default settings without notice (assuming it has not been suspended). An automation's condition is evaluated periodically; the frequency of this periodic evaluation depends on the exact condition. While the details are unspecified, evaluations will be conducted reasonably frequently so that a satisfied condition will be detected in a timely fashion. Once a condition has been detected to be satisfied, the enforcement action will be executed immediately. Currently, the only enforcement action supported is to **enforce** App Check protections on the associated parent service or parent resource policy. Once executed, the automation becomes immutable, and serves as a historical record of that execution. Its `update_time` field will be populated with the timestamp at which the execution occurred, and its `state` field will be set to `SUCCEEDED`. Successful automations not created by the system can still be deleted. If, during the evaluation or execution of an automation, App Check discovers that it is no longer possible for the service or resource to receive App Check protection, App Check may suspend your automation without warning. For example, if you have disabled a service, or have deleted all resources within a service, and that service does not support storing your App Check preferences while it is in such a state, then an automation created for this service may be suspended. Please ensure that the service or resource is correctly configured and operating normally throughout the lifetime of the automation to avoid suspension. + "createTime": "A String", # Output only. Timestamp at which this automation object was created. + "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. + "name": "A String", # Identifier. The relative resource name of the automation object, in one of the following supported formats: ``` projects/{project_number}/services/{service_id}/automations/{automation_id} projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id}/automations/{automation_id} ``` + "origin": "A String", # Output only. The original creator of this automation object. + "state": "A String", # Output only. The state that this automation object is currently in. + "triggerTime": "A String", # A condition that is satisfied if the current time is greater than or equal to the specified timestamp. + "updateTime": "A String", # Output only. Timestamp at which this automation object was most recently updated, either by the system or by the user. If this automation has already been executed, this field indicates the exact timestamp at which it was executed. +} + + updateMask: string, Required. A comma-separated list of names of fields in the Automation to update. Example: `timestamp_condition.enforce_time`. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An **enforcement automation** is useful for automatically enforcing a service or a resource policy within a service when a certain condition is met. For example, you may create an automation that automatically turns on enforcement for your Cloud Firestore service at a specified timestamp in the future. For your security, an automation object may be created by the system in order to protect sensitive services by default. These *system-created* automations can be opted out, if you so choose, by calling the SuspendAutomation method on them. Suspending a system-created automation is not recommended, but is supported for advanced use cases. The system will not execute nor modify any suspended automations. Also, system-created automations **cannot** be deleted, but can be freely modified, which is also not recommended, as the system may later overwrite your changes with its own default settings without notice (assuming it has not been suspended). An automation's condition is evaluated periodically; the frequency of this periodic evaluation depends on the exact condition. While the details are unspecified, evaluations will be conducted reasonably frequently so that a satisfied condition will be detected in a timely fashion. Once a condition has been detected to be satisfied, the enforcement action will be executed immediately. Currently, the only enforcement action supported is to **enforce** App Check protections on the associated parent service or parent resource policy. Once executed, the automation becomes immutable, and serves as a historical record of that execution. Its `update_time` field will be populated with the timestamp at which the execution occurred, and its `state` field will be set to `SUCCEEDED`. Successful automations not created by the system can still be deleted. If, during the evaluation or execution of an automation, App Check discovers that it is no longer possible for the service or resource to receive App Check protection, App Check may suspend your automation without warning. For example, if you have disabled a service, or have deleted all resources within a service, and that service does not support storing your App Check preferences while it is in such a state, then an automation created for this service may be suspended. Please ensure that the service or resource is correctly configured and operating normally throughout the lifetime of the automation to avoid suspension. + "createTime": "A String", # Output only. Timestamp at which this automation object was created. + "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. + "name": "A String", # Identifier. The relative resource name of the automation object, in one of the following supported formats: ``` projects/{project_number}/services/{service_id}/automations/{automation_id} projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id}/automations/{automation_id} ``` + "origin": "A String", # Output only. The original creator of this automation object. + "state": "A String", # Output only. The state that this automation object is currently in. + "triggerTime": "A String", # A condition that is satisfied if the current time is greater than or equal to the specified timestamp. + "updateTime": "A String", # Output only. Timestamp at which this automation object was most recently updated, either by the system or by the user. If this automation has already been executed, this field indicates the exact timestamp at which it was executed. +}+Firebase App Check API . projects . services . resourcePolicies
Instance Methods
++
+automations()+Returns the automations Resource.
+
batchUpdate(parent, body=None, x__xgafv=None)Atomically updates the specified ResourcePolicy configurations.
diff --git a/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.reports.html b/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.reports.html index cb567939ec..5eeac6b04b 100644 --- a/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.reports.html +++ b/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.reports.html @@ -175,6 +175,10 @@Method Details
"displayName": "A String", # Browser name and version number. Formatted to be suitable for passing to BrowserFilter. "displayVersion": "A String", # Browser display version number. }, + "customAttribute": { # Developer-provided custom key-value pair metadata. # Custom attribute metrics group. + "key": "A String", # Output only. Custom attribute key name. + "value": "A String", # Output only. Custom attribute value. + }, "device": { # Mobile device metadata. # Device metrics group. "architecture": "A String", # Device processor architecture. "companyName": "A String", # An invariant name of the manufacturer that submitted this product in its most recognizable public form, e.g. "Google". @@ -310,6 +314,10 @@Method Details
"displayName": "A String", # Browser name and version number. Formatted to be suitable for passing to BrowserFilter. "displayVersion": "A String", # Browser display version number. }, + "customAttribute": { # Developer-provided custom key-value pair metadata. # Custom attribute metrics group. + "key": "A String", # Output only. Custom attribute key name. + "value": "A String", # Output only. Custom attribute value. + }, "device": { # Mobile device metadata. # Device metrics group. "architecture": "A String", # Device processor architecture. "companyName": "A String", # An invariant name of the manufacturer that submitted this product in its most recognizable public form, e.g. "Google". diff --git a/docs/dyn/firebasedataconnect_v1.projects.locations.services.html b/docs/dyn/firebasedataconnect_v1.projects.locations.services.html index 3bbe6a38ea..b16439ab6c 100644 --- a/docs/dyn/firebasedataconnect_v1.projects.locations.services.html +++ b/docs/dyn/firebasedataconnect_v1.projects.locations.services.html @@ -176,12 +176,20 @@Method Details
"createTime": "A String", # Output only. [Output only] Create time stamp. "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) + "graphqlSource": { # Used to represent a set of source files. # Optional. Input only. The GraphQL source files like `dataconnect.yaml` and `*.gql`. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, "labels": { # Optional. Labels as key value pairs. "a_key": "A String", }, "name": "A String", # Identifier. The relative resource name of the Firebase SQL Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ``` Note that the service ID is specific to Firebase SQL Connect and does not correspond to any of the instance IDs of the underlying data source connections. "reconciling": True or False, # Output only. A field that if true, indicates that the system is working update the service. - "schemas": [ # Output only. The list of schemas in this service. + "schemas": [ # Optional. The list of schemas in this service. { # The application schema of a Firebase SQL Connect service. "annotations": { # Optional. Stores small amounts of arbitrary data. "a_key": "A String", @@ -226,7 +234,15 @@Method Details
"updateTime": "A String", # Output only. [Output only] Update time stamp. }, ], - "source": { # Used to represent a set of source files. # Optional. Input only. The source files for service, schemas, and connectors. + "source": { # Used to represent a set of source files. # Optional. Input only. Deprecated: Use `sql_source` or `graphql_source` instead. The source files for service, schemas, and connectors. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, + "sqlSource": { # Used to represent a set of source files. # Optional. Input only. The SQL source files like `*.sql` for deploying a PostgREST service. "files": [ # Required. The files that comprise the source set. { # Individual files. "content": "A String", # Required. The file's textual content. @@ -645,12 +661,20 @@Method Details
"createTime": "A String", # Output only. [Output only] Create time stamp. "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) + "graphqlSource": { # Used to represent a set of source files. # Optional. Input only. The GraphQL source files like `dataconnect.yaml` and `*.gql`. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, "labels": { # Optional. Labels as key value pairs. "a_key": "A String", }, "name": "A String", # Identifier. The relative resource name of the Firebase SQL Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ``` Note that the service ID is specific to Firebase SQL Connect and does not correspond to any of the instance IDs of the underlying data source connections. "reconciling": True or False, # Output only. A field that if true, indicates that the system is working update the service. - "schemas": [ # Output only. The list of schemas in this service. + "schemas": [ # Optional. The list of schemas in this service. { # The application schema of a Firebase SQL Connect service. "annotations": { # Optional. Stores small amounts of arbitrary data. "a_key": "A String", @@ -695,7 +719,15 @@Method Details
"updateTime": "A String", # Output only. [Output only] Update time stamp. }, ], - "source": { # Used to represent a set of source files. # Optional. Input only. The source files for service, schemas, and connectors. + "source": { # Used to represent a set of source files. # Optional. Input only. Deprecated: Use `sql_source` or `graphql_source` instead. The source files for service, schemas, and connectors. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, + "sqlSource": { # Used to represent a set of source files. # Optional. Input only. The SQL source files like `*.sql` for deploying a PostgREST service. "files": [ # Required. The files that comprise the source set. { # Individual files. "content": "A String", # Required. The file's textual content. @@ -847,12 +879,20 @@Method Details
"createTime": "A String", # Output only. [Output only] Create time stamp. "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) + "graphqlSource": { # Used to represent a set of source files. # Optional. Input only. The GraphQL source files like `dataconnect.yaml` and `*.gql`. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, "labels": { # Optional. Labels as key value pairs. "a_key": "A String", }, "name": "A String", # Identifier. The relative resource name of the Firebase SQL Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ``` Note that the service ID is specific to Firebase SQL Connect and does not correspond to any of the instance IDs of the underlying data source connections. "reconciling": True or False, # Output only. A field that if true, indicates that the system is working update the service. - "schemas": [ # Output only. The list of schemas in this service. + "schemas": [ # Optional. The list of schemas in this service. { # The application schema of a Firebase SQL Connect service. "annotations": { # Optional. Stores small amounts of arbitrary data. "a_key": "A String", @@ -897,7 +937,15 @@Method Details
"updateTime": "A String", # Output only. [Output only] Update time stamp. }, ], - "source": { # Used to represent a set of source files. # Optional. Input only. The source files for service, schemas, and connectors. + "source": { # Used to represent a set of source files. # Optional. Input only. Deprecated: Use `sql_source` or `graphql_source` instead. The source files for service, schemas, and connectors. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, + "sqlSource": { # Used to represent a set of source files. # Optional. Input only. The SQL source files like `*.sql` for deploying a PostgREST service. "files": [ # Required. The files that comprise the source set. { # Individual files. "content": "A String", # Required. The file's textual content. @@ -974,12 +1022,20 @@Method Details
"createTime": "A String", # Output only. [Output only] Create time stamp. "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) + "graphqlSource": { # Used to represent a set of source files. # Optional. Input only. The GraphQL source files like `dataconnect.yaml` and `*.gql`. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, "labels": { # Optional. Labels as key value pairs. "a_key": "A String", }, "name": "A String", # Identifier. The relative resource name of the Firebase SQL Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ``` Note that the service ID is specific to Firebase SQL Connect and does not correspond to any of the instance IDs of the underlying data source connections. "reconciling": True or False, # Output only. A field that if true, indicates that the system is working update the service. - "schemas": [ # Output only. The list of schemas in this service. + "schemas": [ # Optional. The list of schemas in this service. { # The application schema of a Firebase SQL Connect service. "annotations": { # Optional. Stores small amounts of arbitrary data. "a_key": "A String", @@ -1024,7 +1080,15 @@Method Details
"updateTime": "A String", # Output only. [Output only] Update time stamp. }, ], - "source": { # Used to represent a set of source files. # Optional. Input only. The source files for service, schemas, and connectors. + "source": { # Used to represent a set of source files. # Optional. Input only. Deprecated: Use `sql_source` or `graphql_source` instead. The source files for service, schemas, and connectors. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, + "sqlSource": { # Used to represent a set of source files. # Optional. Input only. The SQL source files like `*.sql` for deploying a PostgREST service. "files": [ # Required. The files that comprise the source set. { # Individual files. "content": "A String", # Required. The file's textual content. diff --git a/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.html b/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.html index dca94ded81..cd2aaa7915 100644 --- a/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.html +++ b/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.html @@ -176,12 +176,20 @@Method Details
"createTime": "A String", # Output only. [Output only] Create time stamp. "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) + "graphqlSource": { # Used to represent a set of source files. # Optional. Input only. The GraphQL source files like `dataconnect.yaml` and `*.gql`. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, "labels": { # Optional. Labels as key value pairs. "a_key": "A String", }, "name": "A String", # Identifier. The relative resource name of the Firebase SQL Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ``` Note that the service ID is specific to Firebase SQL Connect and does not correspond to any of the instance IDs of the underlying data source connections. "reconciling": True or False, # Output only. A field that if true, indicates that the system is working update the service. - "schemas": [ # Output only. The list of schemas in this service. + "schemas": [ # Optional. The list of schemas in this service. { # The application schema of a Firebase SQL Connect service. "annotations": { # Optional. Stores small amounts of arbitrary data. "a_key": "A String", @@ -226,7 +234,15 @@Method Details
"updateTime": "A String", # Output only. [Output only] Update time stamp. }, ], - "source": { # Used to represent a set of source files. # Optional. Input only. The source files for service, schemas, and connectors. + "source": { # Used to represent a set of source files. # Optional. Input only. Deprecated: Use `sql_source` or `graphql_source` instead. The source files for service, schemas, and connectors. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, + "sqlSource": { # Used to represent a set of source files. # Optional. Input only. The SQL source files like `*.sql` for deploying a PostgREST service. "files": [ # Required. The files that comprise the source set. { # Individual files. "content": "A String", # Required. The file's textual content. @@ -645,12 +661,20 @@Method Details
"createTime": "A String", # Output only. [Output only] Create time stamp. "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) + "graphqlSource": { # Used to represent a set of source files. # Optional. Input only. The GraphQL source files like `dataconnect.yaml` and `*.gql`. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, "labels": { # Optional. Labels as key value pairs. "a_key": "A String", }, "name": "A String", # Identifier. The relative resource name of the Firebase SQL Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ``` Note that the service ID is specific to Firebase SQL Connect and does not correspond to any of the instance IDs of the underlying data source connections. "reconciling": True or False, # Output only. A field that if true, indicates that the system is working update the service. - "schemas": [ # Output only. The list of schemas in this service. + "schemas": [ # Optional. The list of schemas in this service. { # The application schema of a Firebase SQL Connect service. "annotations": { # Optional. Stores small amounts of arbitrary data. "a_key": "A String", @@ -695,7 +719,15 @@Method Details
"updateTime": "A String", # Output only. [Output only] Update time stamp. }, ], - "source": { # Used to represent a set of source files. # Optional. Input only. The source files for service, schemas, and connectors. + "source": { # Used to represent a set of source files. # Optional. Input only. Deprecated: Use `sql_source` or `graphql_source` instead. The source files for service, schemas, and connectors. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, + "sqlSource": { # Used to represent a set of source files. # Optional. Input only. The SQL source files like `*.sql` for deploying a PostgREST service. "files": [ # Required. The files that comprise the source set. { # Individual files. "content": "A String", # Required. The file's textual content. @@ -847,12 +879,20 @@Method Details
"createTime": "A String", # Output only. [Output only] Create time stamp. "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) + "graphqlSource": { # Used to represent a set of source files. # Optional. Input only. The GraphQL source files like `dataconnect.yaml` and `*.gql`. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, "labels": { # Optional. Labels as key value pairs. "a_key": "A String", }, "name": "A String", # Identifier. The relative resource name of the Firebase SQL Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ``` Note that the service ID is specific to Firebase SQL Connect and does not correspond to any of the instance IDs of the underlying data source connections. "reconciling": True or False, # Output only. A field that if true, indicates that the system is working update the service. - "schemas": [ # Output only. The list of schemas in this service. + "schemas": [ # Optional. The list of schemas in this service. { # The application schema of a Firebase SQL Connect service. "annotations": { # Optional. Stores small amounts of arbitrary data. "a_key": "A String", @@ -897,7 +937,15 @@Method Details
"updateTime": "A String", # Output only. [Output only] Update time stamp. }, ], - "source": { # Used to represent a set of source files. # Optional. Input only. The source files for service, schemas, and connectors. + "source": { # Used to represent a set of source files. # Optional. Input only. Deprecated: Use `sql_source` or `graphql_source` instead. The source files for service, schemas, and connectors. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, + "sqlSource": { # Used to represent a set of source files. # Optional. Input only. The SQL source files like `*.sql` for deploying a PostgREST service. "files": [ # Required. The files that comprise the source set. { # Individual files. "content": "A String", # Required. The file's textual content. @@ -974,12 +1022,20 @@Method Details
"createTime": "A String", # Output only. [Output only] Create time stamp. "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) + "graphqlSource": { # Used to represent a set of source files. # Optional. Input only. The GraphQL source files like `dataconnect.yaml` and `*.gql`. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, "labels": { # Optional. Labels as key value pairs. "a_key": "A String", }, "name": "A String", # Identifier. The relative resource name of the Firebase SQL Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ``` Note that the service ID is specific to Firebase SQL Connect and does not correspond to any of the instance IDs of the underlying data source connections. "reconciling": True or False, # Output only. A field that if true, indicates that the system is working update the service. - "schemas": [ # Output only. The list of schemas in this service. + "schemas": [ # Optional. The list of schemas in this service. { # The application schema of a Firebase SQL Connect service. "annotations": { # Optional. Stores small amounts of arbitrary data. "a_key": "A String", @@ -1024,7 +1080,15 @@Method Details
"updateTime": "A String", # Output only. [Output only] Update time stamp. }, ], - "source": { # Used to represent a set of source files. # Optional. Input only. The source files for service, schemas, and connectors. + "source": { # Used to represent a set of source files. # Optional. Input only. Deprecated: Use `sql_source` or `graphql_source` instead. The source files for service, schemas, and connectors. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, + "sqlSource": { # Used to represent a set of source files. # Optional. Input only. The SQL source files like `*.sql` for deploying a PostgREST service. "files": [ # Required. The files that comprise the source set. { # Individual files. "content": "A String", # Required. The file's textual content. diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html index f1064f4d3d..4a6d1bea1b 100644 --- a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html +++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html @@ -105,7 +105,7 @@Method Details
"contents": [ # Optional. Input content. { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` must contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate `Part` with its own `AudioTranscription` carrying the `speaker_label`. # Optional. Audio (input or output) transcription. This is only set when this `Part` contains audio data. "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. `spk_1`, `spk_2`). Present when `diarization` is set. "text": "A String", # Required. The transcription text of this audio segment. @@ -374,7 +374,7 @@Method Details
"model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` must contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate `Part` with its own `AudioTranscription` carrying the `speaker_label`. # Optional. Audio (input or output) transcription. This is only set when this `Part` contains audio data. "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. `spk_1`, `spk_2`). Present when `diarization` is set. "text": "A String", # Required. The transcription text of this audio segment. @@ -744,7 +744,7 @@Method Details
"contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` must contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate `Part` with its own `AudioTranscription` carrying the `speaker_label`. # Optional. Audio (input or output) transcription. This is only set when this `Part` contains audio data. "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. `spk_1`, `spk_2`). Present when `diarization` is set. "text": "A String", # Required. The transcription text of this audio segment. @@ -1024,7 +1024,7 @@Method Details
], "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` must contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate `Part` with its own `AudioTranscription` carrying the `speaker_label`. # Optional. Audio (input or output) transcription. This is only set when this `Part` contains audio data. "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. `spk_1`, `spk_2`). Present when `diarization` is set. "text": "A String", # Required. The transcription text of this audio segment. @@ -1406,7 +1406,7 @@Method Details
}, "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` must contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate `Part` with its own `AudioTranscription` carrying the `speaker_label`. # Optional. Audio (input or output) transcription. This is only set when this `Part` contains audio data. "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. `spk_1`, `spk_2`). Present when `diarization` is set. "text": "A String", # Required. The transcription text of this audio segment. @@ -1705,7 +1705,7 @@Method Details
"contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` must contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate `Part` with its own `AudioTranscription` carrying the `speaker_label`. # Optional. Audio (input or output) transcription. This is only set when this `Part` contains audio data. "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. `spk_1`, `spk_2`). Present when `diarization` is set. "text": "A String", # Required. The transcription text of this audio segment. @@ -1985,7 +1985,7 @@Method Details
], "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` must contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate `Part` with its own `AudioTranscription` carrying the `speaker_label`. # Optional. Audio (input or output) transcription. This is only set when this `Part` contains audio data. "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. `spk_1`, `spk_2`). Present when `diarization` is set. "text": "A String", # Required. The transcription text of this audio segment. @@ -2367,7 +2367,7 @@Method Details
}, "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` must contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate `Part` with its own `AudioTranscription` carrying the `speaker_label`. # Optional. Audio (input or output) transcription. This is only set when this `Part` contains audio data. "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. `spk_1`, `spk_2`). Present when `diarization` is set. "text": "A String", # Required. The transcription text of this audio segment. diff --git a/docs/dyn/gkehub_v1.projects.locations.features.html b/docs/dyn/gkehub_v1.projects.locations.features.html index 0318e9ea1e..3305cfc09a 100644 --- a/docs/dyn/gkehub_v1.projects.locations.features.html +++ b/docs/dyn/gkehub_v1.projects.locations.features.html @@ -143,25 +143,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -358,25 +358,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -674,25 +674,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -1198,25 +1198,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -1413,25 +1413,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -1729,25 +1729,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -2241,25 +2241,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -2456,25 +2456,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -2772,25 +2772,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -3239,25 +3239,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -3454,25 +3454,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -3770,25 +3770,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.features.html b/docs/dyn/gkehub_v1alpha.projects.locations.features.html index 360432fe3c..42077752bf 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.features.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.features.html @@ -146,25 +146,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -369,25 +369,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -703,25 +703,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -1349,25 +1349,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -1572,25 +1572,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -1906,25 +1906,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -2540,25 +2540,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -2763,25 +2763,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -3097,25 +3097,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -3686,25 +3686,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -3909,25 +3909,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -4243,25 +4243,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. diff --git a/docs/dyn/gkehub_v1beta.projects.locations.features.html b/docs/dyn/gkehub_v1beta.projects.locations.features.html index c2f07bde95..2c337173f2 100644 --- a/docs/dyn/gkehub_v1beta.projects.locations.features.html +++ b/docs/dyn/gkehub_v1beta.projects.locations.features.html @@ -146,25 +146,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -368,25 +368,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -693,25 +693,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -1225,25 +1225,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -1447,25 +1447,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -1772,25 +1772,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -2292,25 +2292,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -2514,25 +2514,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -2839,25 +2839,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -3314,25 +3314,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -3536,25 +3536,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -3861,25 +3861,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. diff --git a/docs/dyn/gkehub_v2.projects.locations.memberships.features.html b/docs/dyn/gkehub_v2.projects.locations.memberships.features.html index b529e0a19f..81289aff9a 100644 --- a/docs/dyn/gkehub_v2.projects.locations.memberships.features.html +++ b/docs/dyn/gkehub_v2.projects.locations.memberships.features.html @@ -148,25 +148,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller. # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -475,25 +475,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller. # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -856,25 +856,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller. # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -1183,25 +1183,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller. # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -1504,25 +1504,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller. # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -1831,25 +1831,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller. # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -2161,25 +2161,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller. # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -2488,25 +2488,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller. # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. diff --git a/docs/dyn/gkehub_v2alpha.projects.locations.memberships.features.html b/docs/dyn/gkehub_v2alpha.projects.locations.memberships.features.html index 0b3e8c128a..3ba2d2da85 100644 --- a/docs/dyn/gkehub_v2alpha.projects.locations.memberships.features.html +++ b/docs/dyn/gkehub_v2alpha.projects.locations.memberships.features.html @@ -148,25 +148,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller. # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -475,25 +475,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller. # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -856,25 +856,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller. # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -1183,25 +1183,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller. # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -1504,25 +1504,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller. # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -1831,25 +1831,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller. # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -2161,25 +2161,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller. # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -2488,25 +2488,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller. # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. diff --git a/docs/dyn/gkehub_v2beta.projects.locations.memberships.features.html b/docs/dyn/gkehub_v2beta.projects.locations.memberships.features.html index 104ed543f3..c50641c90a 100644 --- a/docs/dyn/gkehub_v2beta.projects.locations.memberships.features.html +++ b/docs/dyn/gkehub_v2beta.projects.locations.memberships.features.html @@ -148,25 +148,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller. # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -475,25 +475,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller. # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -856,25 +856,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller. # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -1183,25 +1183,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller. # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -1504,25 +1504,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller. # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -1831,25 +1831,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller. # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -2161,25 +2161,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller. # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. @@ -2488,25 +2488,25 @@Method Details
], "enabled": True or False, # Optional. Enables the installation of Config Sync. If set to true, the Feature will manage Config Sync resources, and apply the other ConfigSync fields if they exist. If set to false, the Feature will ignore all other ConfigSync fields and delete the Config Sync resources. If omitted, ConfigSync is considered enabled if the git or oci field is present. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. - "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Only specify when secret_type is `cookiefile`, `token`, or `none`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. + "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. Defines an HTTPS_PROXY environment variable and only accepts `https` or unadorned URLs. For example, `https://proxy.internal.business.co:443` or `proxy.internal.business.co:443`. If using an unadorned URL, make sure the communication between your proxy server and Git host is secure. Rejects `http://` URLs. Only specify when secret_type is `cookiefile`, `token`, or `none`. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of `ssh`, `cookiefile`, `gcenode`, `token`, `gcpserviceaccount`, `githubapp` or `none`. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. - "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. + "syncRev": "A String", # Optional. Git revision (tag or hash) or branch to sync from. Default `HEAD`. If not `HEAD`, takes precedence over `sync_branch` field. When using a hash, must be a full hash, and not an abbreviated form. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "metricsGcpServiceAccountEmail": "A String", # Optional. The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. - "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. + "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is `gcpserviceaccount`. Annotates the `RootSync` or `RepoSync` controller's Kubernetes Service Account. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of `gcenode`, `gcpserviceaccount`, `k8sserviceaccount` or `none`. The validation of this is case-sensitive. "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to false, disables the Config Sync admission webhook and does not prevent drifts. Defaults to false. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/prevent-config-drift for details. - "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchical` or `unstructured` mode. Defaults to `hierarchical`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. + "sourceFormat": "A String", # Optional. Specifies whether the Config Sync repo is in `hierarchy` or `unstructured` mode. Defaults to `hierarchy`. See https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/concepts/configs#organize-configs for an explanation. "stopSyncing": True or False, # Optional. Set to true to stop syncing configs for a single cluster. Default to false. }, "hierarchyController": { # Configuration for Hierarchy Controller. # Optional. Hierarchy Controller configuration for the cluster. Deprecated: Configuring Hierarchy Controller through the configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. diff --git a/docs/dyn/health_v4beta.users.dataTypes.dataPoints.html b/docs/dyn/health_v4beta.users.dataTypes.dataPoints.html index 67745c3e5b..6f285ce1f0 100644 --- a/docs/dyn/health_v4beta.users.dataTypes.dataPoints.html +++ b/docs/dyn/health_v4beta.users.dataTypes.dataPoints.html @@ -1342,31 +1342,6 @@Method Details
"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). }, }, - "skinTemperature": { # Skin temperature measurement. # Optional. Data for points in the `skin-temperature` sample data type collection. - "baselineTemperatureCelsius": 3.14, # Required. The baseline skin temperature in Celsius. Must be in the range `[0, 100]`. - "metadata": { # Metadata for the skin temperature measurement. # Optional. Metadata for the skin temperature measurement. - "measurementLocation": "A String", # Optional. The location of the skin temperature measurement. - "measurementState": "A String", # Optional. The motion state of the skin temperature measurement. - }, - "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which skin 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 skin temperature in Celsius. Must be in the range `[0, 100]`. - }, "skinTemperatureSensors": { # Skin temperature sensor data containing multi-sensor readings. # Optional. Data for points in the `skin-temperature-sensors` sample data type collection. "sampleTime": { # Represents a sample time of an observed data point. # Required. The observation sample 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. @@ -1874,11 +1849,6 @@Method Details
"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. }, - "skinTemperature": { # Represents the result of the rollup of the skin temperature data type. # Returned by default when rolling up data points from the `skin-temperature` data type. - "temperatureCelsiusAvg": 3.14, # Average skin temperature in Celsius. - "temperatureCelsiusMax": 3.14, # Maximum skin temperature in Celsius. - "temperatureCelsiusMin": 3.14, # Minimum skin temperature in Celsius. - }, "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. }, @@ -3134,31 +3104,6 @@Method Details
"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). }, }, - "skinTemperature": { # Skin temperature measurement. # Optional. Data for points in the `skin-temperature` sample data type collection. - "baselineTemperatureCelsius": 3.14, # Required. The baseline skin temperature in Celsius. Must be in the range `[0, 100]`. - "metadata": { # Metadata for the skin temperature measurement. # Optional. Metadata for the skin temperature measurement. - "measurementLocation": "A String", # Optional. The location of the skin temperature measurement. - "measurementState": "A String", # Optional. The motion state of the skin temperature measurement. - }, - "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which skin 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 skin temperature in Celsius. Must be in the range `[0, 100]`. - }, "skinTemperatureSensors": { # Skin temperature sensor data containing multi-sensor readings. # Optional. Data for points in the `skin-temperature-sensors` sample data type collection. "sampleTime": { # Represents a sample time of an observed data point. # Required. The observation sample 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. @@ -4634,31 +4579,6 @@Method Details
"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). }, }, - "skinTemperature": { # Skin temperature measurement. # Optional. Data for points in the `skin-temperature` sample data type collection. - "baselineTemperatureCelsius": 3.14, # Required. The baseline skin temperature in Celsius. Must be in the range `[0, 100]`. - "metadata": { # Metadata for the skin temperature measurement. # Optional. Metadata for the skin temperature measurement. - "measurementLocation": "A String", # Optional. The location of the skin temperature measurement. - "measurementState": "A String", # Optional. The motion state of the skin temperature measurement. - }, - "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which skin 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 skin temperature in Celsius. Must be in the range `[0, 100]`. - }, "skinTemperatureSensors": { # Skin temperature sensor data containing multi-sensor readings. # Optional. Data for points in the `skin-temperature-sensors` sample data type collection. "sampleTime": { # Represents a sample time of an observed data point. # Required. The observation sample 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. @@ -6140,31 +6060,6 @@Method Details
"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). }, }, - "skinTemperature": { # Skin temperature measurement. # Optional. Data for points in the `skin-temperature` sample data type collection. - "baselineTemperatureCelsius": 3.14, # Required. The baseline skin temperature in Celsius. Must be in the range `[0, 100]`. - "metadata": { # Metadata for the skin temperature measurement. # Optional. Metadata for the skin temperature measurement. - "measurementLocation": "A String", # Optional. The location of the skin temperature measurement. - "measurementState": "A String", # Optional. The motion state of the skin temperature measurement. - }, - "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which skin 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 skin temperature in Celsius. Must be in the range `[0, 100]`. - }, "skinTemperatureSensors": { # Skin temperature sensor data containing multi-sensor readings. # Optional. Data for points in the `skin-temperature-sensors` sample data type collection. "sampleTime": { # Represents a sample time of an observed data point. # Required. The observation sample 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. @@ -7368,31 +7263,6 @@Method Details
"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). }, }, - "skinTemperature": { # Skin temperature measurement. # Data for points in the `skin-temperature` sample data type collection. - "baselineTemperatureCelsius": 3.14, # Required. The baseline skin temperature in Celsius. Must be in the range `[0, 100]`. - "metadata": { # Metadata for the skin temperature measurement. # Optional. Metadata for the skin temperature measurement. - "measurementLocation": "A String", # Optional. The location of the skin temperature measurement. - "measurementState": "A String", # Optional. The motion state of the skin temperature measurement. - }, - "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which skin 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 skin temperature in Celsius. Must be in the range `[0, 100]`. - }, "skinTemperatureSensors": { # Skin temperature sensor data containing multi-sensor readings. # Data for points in the `skin-temperature-sensors` sample data type collection. "sampleTime": { # Represents a sample time of an observed data point. # Required. The observation sample 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. @@ -7810,11 +7680,6 @@Method Details
"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. }, - "skinTemperature": { # Represents the result of the rollup of the skin temperature data type. # Returned by default when rolling up data points from the `skin-temperature` data type. - "temperatureCelsiusAvg": 3.14, # Average skin temperature in Celsius. - "temperatureCelsiusMax": 3.14, # Maximum skin temperature in Celsius. - "temperatureCelsiusMin": 3.14, # Minimum skin temperature in Celsius. - }, "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. diff --git a/docs/dyn/iam_v1.locations.workforcePools.subjects.html b/docs/dyn/iam_v1.locations.workforcePools.subjects.html index 90fa33418a..ced3614a42 100644 --- a/docs/dyn/iam_v1.locations.workforcePools.subjects.html +++ b/docs/dyn/iam_v1.locations.workforcePools.subjects.html @@ -87,7 +87,7 @@Instance Methods
Deletes a WorkforcePoolSubject. Subject must not already be in a deleted state. A WorkforcePoolSubject is automatically created the first time an external credential is exchanged for a Google Cloud credential using a mapped `google.subject` attribute. There is no endpoint to manually create a WorkforcePoolSubject. For 30 days after a WorkforcePoolSubject is deleted, using the same `google.subject` attribute in token exchanges with Google Cloud STS fails. Call UndeleteWorkforcePoolSubject to undelete a WorkforcePoolSubject that has been deleted, within within 30 days of deleting it. After 30 days, the WorkforcePoolSubject is permanently deleted. At this point, a token exchange with Google Cloud STS that uses the same mapped `google.subject` attribute automatically creates a new WorkforcePoolSubject that is unrelated to the previously deleted WorkforcePoolSubject but has the same `google.subject` value.
-
revokeSessions(name, body=None, x__xgafv=None)Revokes all sessions for a given WorkforcePoolSubject.
+Revokes all sessions for the specified WorkforcePoolSubject. Revoking sessions invalidates all active sessions and previously issued credentials for the subject, requiring the user to re-authenticate with the identity provider.
undelete(name, body=None, x__xgafv=None)Undeletes a WorkforcePoolSubject, as long as it was deleted fewer than 30 days ago.
@@ -134,10 +134,10 @@Method Details
revokeSessions(name, body=None, x__xgafv=None)-Revokes all sessions for a given WorkforcePoolSubject. +Revokes all sessions for the specified WorkforcePoolSubject. Revoking sessions invalidates all active sessions and previously issued credentials for the subject, requiring the user to re-authenticate with the identity provider. Args: - name: string, Required. The resource name of the WorkforcePoolSubject. Special characters, like `/` and `:`, must be escaped, because all URLs need to conform to the "When to Escape and Unescape" section of [RFC3986](https://www.ietf.org/rfc/rfc2396.txt). Format: `locations/{location}/workforcePools/{workforce_pool_id}/subjects/{subject_id}` (required) + name: string, Required. The resource name of the WorkforcePoolSubject. Special characters, such as `/` and `:`, must be escaped, because all URLs must conform to the "When to Escape and Unescape" section of [RFC 3986](https://www.rfc-editor.org/info/rfc3986/). Format: `locations/{location}/workforcePools/{workforce_pool_id}/subjects/{subject_id}` (required) body: object, The request body. The object takes the form of: diff --git a/docs/dyn/iam_v1.projects.locations.workloadIdentityPools.providers.html b/docs/dyn/iam_v1.projects.locations.workloadIdentityPools.providers.html index e8c4c101b9..41484f877e 100644 --- a/docs/dyn/iam_v1.projects.locations.workloadIdentityPools.providers.html +++ b/docs/dyn/iam_v1.projects.locations.workloadIdentityPools.providers.html @@ -124,6 +124,9 @@Method Details
The object takes the form of: { # A configuration for an external identity provider. + "actorProviders": [ # Optional. A list of the resource names of WorkloadIdentityPoolProviders in the same pool that are authorized to issue actor tokens for this provider. An actor token represents the identity of the acting party to whom authority is delegated. At most 3 actor providers can be specified. + "A String", + ], "attributeCondition": "A String", # Optional. [A Common Expression Language](https://opensource.google/projects/cel) expression, in plain text, to restrict what otherwise valid authentication credentials issued by the provider should not be accepted. The expression must output a boolean representing whether to allow the federation. The following keywords may be referenced in the expressions: * `assertion`: JSON representing the authentication credential issued by the provider. * `google`: The Google attributes mapped from the assertion in the `attribute_mappings`. * `attribute`: The custom attributes mapped from the assertion in the `attribute_mappings`. The maximum length of the `attribute_condition` expression is 4,096 characters. Providing a condition longer than this will result in an error. If unspecified, all valid authentication credentials are accepted. However, multi-tenant identity providers (such as GitHub or Terraform Cloud) require an `attribute_condition` to prevent token spoofing. The following example shows how to only allow credentials with a mapped `google.groups` value of `admins`: ``` "'admins' in google.groups" ``` "attributeMapping": { # Optional. Maps attributes from authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. Cannot exceed 127 bytes. * `google.groups`: Groups the external identity belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where `{custom_attribute}` is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workload to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 8KB. For AWS providers, if no attribute mapping is defined, the following default mapping applies: ``` { "google.subject":"assertion.arn", "attribute.aws_role": "assertion.arn.contains('assumed-role')" " ? assertion.arn.extract('{account_arn}assumed-role/')" " + 'assumed-role/'" " + assertion.arn.extract('assumed-role/{role_name}/')" " : assertion.arn", } ``` If any custom attribute mappings are defined, they must include a mapping to the `google.subject` attribute. For OIDC providers, you must supply a custom mapping, which must include the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ``` "a_key": "A String", @@ -140,6 +143,7 @@Method Details
"allowedAudiences": [ # Optional. Acceptable values for the `aud` field (audience) in the OIDC token. Token exchange requests are rejected if the token audience does not match one of the configured values. Each audience may be at most 256 characters. A maximum of 10 audiences may be configured. If this list is empty, the OIDC token audience must be equal to the full canonical resource name of the WorkloadIdentityPoolProvider, with or without the HTTPS prefix. For example: ``` //iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ https://iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ ``` "A String", ], + "discoveryUri": "A String", # Optional. The URL to fetch the OIDC discovery document from, overriding the default URL derived from `issuer_uri`. If not set, `discovery_uri` defaults to `issuer_uri` with `/.well-known/openid-configuration` appended, as per the OpenID Connect Discovery 1.0 specification. If set, `discovery_uri` must meet the following requirements: - Must start with `https://`. - Must not exceed 2000 characters. - The scheme, host, and port must match `issuer_uri`. - The path must contain `/.well-known/` (where `` is not empty, such as `openid-configuration`) and conform to the `issuer_uri` topology: - The well-known path segment is inserted before the issuer path (for example, `https://example.com/.well-known/openid-configuration/tenant1` for issuer `https://example.com/tenant1`), or - The well-known path segment is appended under the issuer path (for example, `https://example.com/tenant1/.well-known/openid-configuration` for issuer `https://example.com/tenant1`). "issuerUri": "A String", # Required. The OIDC `issuer_uri`. Must be an HTTPS endpoint. Per OpenID Connect Discovery 1.0 spec, the OIDC issuer URL is used to locate the provider's public keys (via `jwks_uri`) for verifying tokens like the OIDC ID token. These public key types must be 'EC' or 'RSA'. "jwksJson": "A String", # Optional. OIDC JWKs in JSON String format. For details on the definition of a JWK, see https://tools.ietf.org/html/rfc7517. If not set, the `jwks_uri` from the discovery document(fetched from the .well-known path of the `issuer_uri`) will be used. Currently, RSA and EC asymmetric keys are supported. The JWK must use following format and include only the following fields: { "keys": [ { "kty": "RSA/EC", "alg": "", "use": "sig", "kid": "", "n": "", "e": "", "x": "", "y": "", "crv": "" } ] } }, @@ -244,6 +248,9 @@Method Details
An object of the form: { # A configuration for an external identity provider. + "actorProviders": [ # Optional. A list of the resource names of WorkloadIdentityPoolProviders in the same pool that are authorized to issue actor tokens for this provider. An actor token represents the identity of the acting party to whom authority is delegated. At most 3 actor providers can be specified. + "A String", + ], "attributeCondition": "A String", # Optional. [A Common Expression Language](https://opensource.google/projects/cel) expression, in plain text, to restrict what otherwise valid authentication credentials issued by the provider should not be accepted. The expression must output a boolean representing whether to allow the federation. The following keywords may be referenced in the expressions: * `assertion`: JSON representing the authentication credential issued by the provider. * `google`: The Google attributes mapped from the assertion in the `attribute_mappings`. * `attribute`: The custom attributes mapped from the assertion in the `attribute_mappings`. The maximum length of the `attribute_condition` expression is 4,096 characters. Providing a condition longer than this will result in an error. If unspecified, all valid authentication credentials are accepted. However, multi-tenant identity providers (such as GitHub or Terraform Cloud) require an `attribute_condition` to prevent token spoofing. The following example shows how to only allow credentials with a mapped `google.groups` value of `admins`: ``` "'admins' in google.groups" ``` "attributeMapping": { # Optional. Maps attributes from authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. Cannot exceed 127 bytes. * `google.groups`: Groups the external identity belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where `{custom_attribute}` is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workload to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 8KB. For AWS providers, if no attribute mapping is defined, the following default mapping applies: ``` { "google.subject":"assertion.arn", "attribute.aws_role": "assertion.arn.contains('assumed-role')" " ? assertion.arn.extract('{account_arn}assumed-role/')" " + 'assumed-role/'" " + assertion.arn.extract('assumed-role/{role_name}/')" " : assertion.arn", } ``` If any custom attribute mappings are defined, they must include a mapping to the `google.subject` attribute. For OIDC providers, you must supply a custom mapping, which must include the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ``` "a_key": "A String", @@ -260,6 +267,7 @@Method Details
"allowedAudiences": [ # Optional. Acceptable values for the `aud` field (audience) in the OIDC token. Token exchange requests are rejected if the token audience does not match one of the configured values. Each audience may be at most 256 characters. A maximum of 10 audiences may be configured. If this list is empty, the OIDC token audience must be equal to the full canonical resource name of the WorkloadIdentityPoolProvider, with or without the HTTPS prefix. For example: ``` //iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ https://iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ ``` "A String", ], + "discoveryUri": "A String", # Optional. The URL to fetch the OIDC discovery document from, overriding the default URL derived from `issuer_uri`. If not set, `discovery_uri` defaults to `issuer_uri` with `/.well-known/openid-configuration` appended, as per the OpenID Connect Discovery 1.0 specification. If set, `discovery_uri` must meet the following requirements: - Must start with `https://`. - Must not exceed 2000 characters. - The scheme, host, and port must match `issuer_uri`. - The path must contain `/.well-known/` (where `` is not empty, such as `openid-configuration`) and conform to the `issuer_uri` topology: - The well-known path segment is inserted before the issuer path (for example, `https://example.com/.well-known/openid-configuration/tenant1` for issuer `https://example.com/tenant1`), or - The well-known path segment is appended under the issuer path (for example, `https://example.com/tenant1/.well-known/openid-configuration` for issuer `https://example.com/tenant1`). "issuerUri": "A String", # Required. The OIDC `issuer_uri`. Must be an HTTPS endpoint. Per OpenID Connect Discovery 1.0 spec, the OIDC issuer URL is used to locate the provider's public keys (via `jwks_uri`) for verifying tokens like the OIDC ID token. These public key types must be 'EC' or 'RSA'. "jwksJson": "A String", # Optional. OIDC JWKs in JSON String format. For details on the definition of a JWK, see https://tools.ietf.org/html/rfc7517. If not set, the `jwks_uri` from the discovery document(fetched from the .well-known path of the `issuer_uri`) will be used. Currently, RSA and EC asymmetric keys are supported. The JWK must use following format and include only the following fields: { "keys": [ { "kty": "RSA/EC", "alg": "", "use": "sig", "kid": "", "n": "", "e": "", "x": "", "y": "", "crv": "" } ] } }, @@ -306,6 +314,9 @@Method Details
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. "workloadIdentityPoolProviders": [ # A list of providers. { # A configuration for an external identity provider. + "actorProviders": [ # Optional. A list of the resource names of WorkloadIdentityPoolProviders in the same pool that are authorized to issue actor tokens for this provider. An actor token represents the identity of the acting party to whom authority is delegated. At most 3 actor providers can be specified. + "A String", + ], "attributeCondition": "A String", # Optional. [A Common Expression Language](https://opensource.google/projects/cel) expression, in plain text, to restrict what otherwise valid authentication credentials issued by the provider should not be accepted. The expression must output a boolean representing whether to allow the federation. The following keywords may be referenced in the expressions: * `assertion`: JSON representing the authentication credential issued by the provider. * `google`: The Google attributes mapped from the assertion in the `attribute_mappings`. * `attribute`: The custom attributes mapped from the assertion in the `attribute_mappings`. The maximum length of the `attribute_condition` expression is 4,096 characters. Providing a condition longer than this will result in an error. If unspecified, all valid authentication credentials are accepted. However, multi-tenant identity providers (such as GitHub or Terraform Cloud) require an `attribute_condition` to prevent token spoofing. The following example shows how to only allow credentials with a mapped `google.groups` value of `admins`: ``` "'admins' in google.groups" ``` "attributeMapping": { # Optional. Maps attributes from authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. Cannot exceed 127 bytes. * `google.groups`: Groups the external identity belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where `{custom_attribute}` is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workload to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 8KB. For AWS providers, if no attribute mapping is defined, the following default mapping applies: ``` { "google.subject":"assertion.arn", "attribute.aws_role": "assertion.arn.contains('assumed-role')" " ? assertion.arn.extract('{account_arn}assumed-role/')" " + 'assumed-role/'" " + assertion.arn.extract('assumed-role/{role_name}/')" " : assertion.arn", } ``` If any custom attribute mappings are defined, they must include a mapping to the `google.subject` attribute. For OIDC providers, you must supply a custom mapping, which must include the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ``` "a_key": "A String", @@ -322,6 +333,7 @@Method Details
"allowedAudiences": [ # Optional. Acceptable values for the `aud` field (audience) in the OIDC token. Token exchange requests are rejected if the token audience does not match one of the configured values. Each audience may be at most 256 characters. A maximum of 10 audiences may be configured. If this list is empty, the OIDC token audience must be equal to the full canonical resource name of the WorkloadIdentityPoolProvider, with or without the HTTPS prefix. For example: ``` //iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ https://iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ ``` "A String", ], + "discoveryUri": "A String", # Optional. The URL to fetch the OIDC discovery document from, overriding the default URL derived from `issuer_uri`. If not set, `discovery_uri` defaults to `issuer_uri` with `/.well-known/openid-configuration` appended, as per the OpenID Connect Discovery 1.0 specification. If set, `discovery_uri` must meet the following requirements: - Must start with `https://`. - Must not exceed 2000 characters. - The scheme, host, and port must match `issuer_uri`. - The path must contain `/.well-known/` (where `` is not empty, such as `openid-configuration`) and conform to the `issuer_uri` topology: - The well-known path segment is inserted before the issuer path (for example, `https://example.com/.well-known/openid-configuration/tenant1` for issuer `https://example.com/tenant1`), or - The well-known path segment is appended under the issuer path (for example, `https://example.com/tenant1/.well-known/openid-configuration` for issuer `https://example.com/tenant1`). "issuerUri": "A String", # Required. The OIDC `issuer_uri`. Must be an HTTPS endpoint. Per OpenID Connect Discovery 1.0 spec, the OIDC issuer URL is used to locate the provider's public keys (via `jwks_uri`) for verifying tokens like the OIDC ID token. These public key types must be 'EC' or 'RSA'. "jwksJson": "A String", # Optional. OIDC JWKs in JSON String format. For details on the definition of a JWK, see https://tools.ietf.org/html/rfc7517. If not set, the `jwks_uri` from the discovery document(fetched from the .well-known path of the `issuer_uri`) will be used. Currently, RSA and EC asymmetric keys are supported. The JWK must use following format and include only the following fields: { "keys": [ { "kty": "RSA/EC", "alg": "", "use": "sig", "kid": "", "n": "", "e": "", "x": "", "y": "", "crv": "" } ] } }, @@ -373,6 +385,9 @@Method Details
The object takes the form of: { # A configuration for an external identity provider. + "actorProviders": [ # Optional. A list of the resource names of WorkloadIdentityPoolProviders in the same pool that are authorized to issue actor tokens for this provider. An actor token represents the identity of the acting party to whom authority is delegated. At most 3 actor providers can be specified. + "A String", + ], "attributeCondition": "A String", # Optional. [A Common Expression Language](https://opensource.google/projects/cel) expression, in plain text, to restrict what otherwise valid authentication credentials issued by the provider should not be accepted. The expression must output a boolean representing whether to allow the federation. The following keywords may be referenced in the expressions: * `assertion`: JSON representing the authentication credential issued by the provider. * `google`: The Google attributes mapped from the assertion in the `attribute_mappings`. * `attribute`: The custom attributes mapped from the assertion in the `attribute_mappings`. The maximum length of the `attribute_condition` expression is 4,096 characters. Providing a condition longer than this will result in an error. If unspecified, all valid authentication credentials are accepted. However, multi-tenant identity providers (such as GitHub or Terraform Cloud) require an `attribute_condition` to prevent token spoofing. The following example shows how to only allow credentials with a mapped `google.groups` value of `admins`: ``` "'admins' in google.groups" ``` "attributeMapping": { # Optional. Maps attributes from authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. Cannot exceed 127 bytes. * `google.groups`: Groups the external identity belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where `{custom_attribute}` is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workload to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 8KB. For AWS providers, if no attribute mapping is defined, the following default mapping applies: ``` { "google.subject":"assertion.arn", "attribute.aws_role": "assertion.arn.contains('assumed-role')" " ? assertion.arn.extract('{account_arn}assumed-role/')" " + 'assumed-role/'" " + assertion.arn.extract('assumed-role/{role_name}/')" " : assertion.arn", } ``` If any custom attribute mappings are defined, they must include a mapping to the `google.subject` attribute. For OIDC providers, you must supply a custom mapping, which must include the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ``` "a_key": "A String", @@ -389,6 +404,7 @@Method Details
"allowedAudiences": [ # Optional. Acceptable values for the `aud` field (audience) in the OIDC token. Token exchange requests are rejected if the token audience does not match one of the configured values. Each audience may be at most 256 characters. A maximum of 10 audiences may be configured. If this list is empty, the OIDC token audience must be equal to the full canonical resource name of the WorkloadIdentityPoolProvider, with or without the HTTPS prefix. For example: ``` //iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ https://iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ ``` "A String", ], + "discoveryUri": "A String", # Optional. The URL to fetch the OIDC discovery document from, overriding the default URL derived from `issuer_uri`. If not set, `discovery_uri` defaults to `issuer_uri` with `/.well-known/openid-configuration` appended, as per the OpenID Connect Discovery 1.0 specification. If set, `discovery_uri` must meet the following requirements: - Must start with `https://`. - Must not exceed 2000 characters. - The scheme, host, and port must match `issuer_uri`. - The path must contain `/.well-known/` (where `` is not empty, such as `openid-configuration`) and conform to the `issuer_uri` topology: - The well-known path segment is inserted before the issuer path (for example, `https://example.com/.well-known/openid-configuration/tenant1` for issuer `https://example.com/tenant1`), or - The well-known path segment is appended under the issuer path (for example, `https://example.com/tenant1/.well-known/openid-configuration` for issuer `https://example.com/tenant1`). "issuerUri": "A String", # Required. The OIDC `issuer_uri`. Must be an HTTPS endpoint. Per OpenID Connect Discovery 1.0 spec, the OIDC issuer URL is used to locate the provider's public keys (via `jwks_uri`) for verifying tokens like the OIDC ID token. These public key types must be 'EC' or 'RSA'. "jwksJson": "A String", # Optional. OIDC JWKs in JSON String format. For details on the definition of a JWK, see https://tools.ietf.org/html/rfc7517. If not set, the `jwks_uri` from the discovery document(fetched from the .well-known path of the `issuer_uri`) will be used. Currently, RSA and EC asymmetric keys are supported. The JWK must use following format and include only the following fields: { "keys": [ { "kty": "RSA/EC", "alg": "", "use": "sig", "kid": "", "n": "", "e": "", "x": "", "y": "", "crv": "" } ] } }, diff --git a/docs/dyn/integrations_v1.projects.locations.integrations.executions.suspensions.html b/docs/dyn/integrations_v1.projects.locations.integrations.executions.suspensions.html index 7e42de6aeb..8be87bc49f 100644 --- a/docs/dyn/integrations_v1.projects.locations.integrations.executions.suspensions.html +++ b/docs/dyn/integrations_v1.projects.locations.integrations.executions.suspensions.html @@ -245,7 +245,7 @@Method Details
"testMode": True or False, # Optional. Sets test mode in {@link enterprise/crm/eventbus/event_message.proto}. "triggerId": "A String", # Matched against all {@link TriggerConfig}s across all workflows. i.e. TriggerConfig.trigger_id.equals(trigger_id) Required. "userGeneratedExecutionId": "A String", # This is a unique id provided by the method caller. If provided this will be used as the execution_id when a new execution info is created. This is a string representation of a UUID. Must have no more than 36 characters and contain only alphanumeric characters and hyphens. - "workflowId": "A String", # Optional. Pins the enqueue to this exact version rather than the ACTIVE one on the trigger, so an unpublished draft can be tested. Requires client_id, and the version is validated before it is enqueued; see integrationplatform/api/executionsservice/README.md. + "workflowId": "A String", # Optional. Pins the enqueue to this exact version. Requires client_id, and only an ACTIVE version is accepted: the drain re-resolves by trigger id, so nothing else could run. Unset by every caller today; draft support is b/570602030. See integrationplatform/api/executionsservice/README.md. "workflowName": "A String", # Optional. If provided, the workflow_name is used to filter all the matched workflows having same trigger_id+client_id. A combination of trigger_id, client_id and workflow_name identifies a unique workflow. }, "suspensionInfoEventParameterKey": "A String", # In the fired event, set the SuspensionInfo message as the value for this key. @@ -405,7 +405,7 @@Method Details
"testMode": True or False, # Optional. Sets test mode in {@link enterprise/crm/eventbus/event_message.proto}. "triggerId": "A String", # Matched against all {@link TriggerConfig}s across all workflows. i.e. TriggerConfig.trigger_id.equals(trigger_id) Required. "userGeneratedExecutionId": "A String", # This is a unique id provided by the method caller. If provided this will be used as the execution_id when a new execution info is created. This is a string representation of a UUID. Must have no more than 36 characters and contain only alphanumeric characters and hyphens. - "workflowId": "A String", # Optional. Pins the enqueue to this exact version rather than the ACTIVE one on the trigger, so an unpublished draft can be tested. Requires client_id, and the version is validated before it is enqueued; see integrationplatform/api/executionsservice/README.md. + "workflowId": "A String", # Optional. Pins the enqueue to this exact version. Requires client_id, and only an ACTIVE version is accepted: the drain re-resolves by trigger id, so nothing else could run. Unset by every caller today; draft support is b/570602030. See integrationplatform/api/executionsservice/README.md. "workflowName": "A String", # Optional. If provided, the workflow_name is used to filter all the matched workflows having same trigger_id+client_id. A combination of trigger_id, client_id and workflow_name identifies a unique workflow. }, "suspensionInfoEventParameterKey": "A String", # In the fired event, set the SuspensionInfo message as the value for this key. diff --git a/docs/dyn/integrations_v1.projects.locations.products.integrations.executions.suspensions.html b/docs/dyn/integrations_v1.projects.locations.products.integrations.executions.suspensions.html index 528c81e6c1..9029b8158f 100644 --- a/docs/dyn/integrations_v1.projects.locations.products.integrations.executions.suspensions.html +++ b/docs/dyn/integrations_v1.projects.locations.products.integrations.executions.suspensions.html @@ -245,7 +245,7 @@Method Details
"testMode": True or False, # Optional. Sets test mode in {@link enterprise/crm/eventbus/event_message.proto}. "triggerId": "A String", # Matched against all {@link TriggerConfig}s across all workflows. i.e. TriggerConfig.trigger_id.equals(trigger_id) Required. "userGeneratedExecutionId": "A String", # This is a unique id provided by the method caller. If provided this will be used as the execution_id when a new execution info is created. This is a string representation of a UUID. Must have no more than 36 characters and contain only alphanumeric characters and hyphens. - "workflowId": "A String", # Optional. Pins the enqueue to this exact version rather than the ACTIVE one on the trigger, so an unpublished draft can be tested. Requires client_id, and the version is validated before it is enqueued; see integrationplatform/api/executionsservice/README.md. + "workflowId": "A String", # Optional. Pins the enqueue to this exact version. Requires client_id, and only an ACTIVE version is accepted: the drain re-resolves by trigger id, so nothing else could run. Unset by every caller today; draft support is b/570602030. See integrationplatform/api/executionsservice/README.md. "workflowName": "A String", # Optional. If provided, the workflow_name is used to filter all the matched workflows having same trigger_id+client_id. A combination of trigger_id, client_id and workflow_name identifies a unique workflow. }, "suspensionInfoEventParameterKey": "A String", # In the fired event, set the SuspensionInfo message as the value for this key. @@ -405,7 +405,7 @@Method Details
"testMode": True or False, # Optional. Sets test mode in {@link enterprise/crm/eventbus/event_message.proto}. "triggerId": "A String", # Matched against all {@link TriggerConfig}s across all workflows. i.e. TriggerConfig.trigger_id.equals(trigger_id) Required. "userGeneratedExecutionId": "A String", # This is a unique id provided by the method caller. If provided this will be used as the execution_id when a new execution info is created. This is a string representation of a UUID. Must have no more than 36 characters and contain only alphanumeric characters and hyphens. - "workflowId": "A String", # Optional. Pins the enqueue to this exact version rather than the ACTIVE one on the trigger, so an unpublished draft can be tested. Requires client_id, and the version is validated before it is enqueued; see integrationplatform/api/executionsservice/README.md. + "workflowId": "A String", # Optional. Pins the enqueue to this exact version. Requires client_id, and only an ACTIVE version is accepted: the drain re-resolves by trigger id, so nothing else could run. Unset by every caller today; draft support is b/570602030. See integrationplatform/api/executionsservice/README.md. "workflowName": "A String", # Optional. If provided, the workflow_name is used to filter all the matched workflows having same trigger_id+client_id. A combination of trigger_id, client_id and workflow_name identifies a unique workflow. }, "suspensionInfoEventParameterKey": "A String", # In the fired event, set the SuspensionInfo message as the value for this key. diff --git a/docs/dyn/merchantapi_products_v1.accounts.productInputs.html b/docs/dyn/merchantapi_products_v1.accounts.productInputs.html index b244c099c4..31c108ae00 100644 --- a/docs/dyn/merchantapi_products_v1.accounts.productInputs.html +++ b/docs/dyn/merchantapi_products_v1.accounts.productInputs.html @@ -643,7 +643,7 @@Method Details
], "vin": "A String", # The [Vehicle Identification Number (VIN)](https://support.google.com/google-ads/answer/14154510) of the vehicle. "virtualModelLink": "A String", # URL of the 3D image of the item. See the [Help Center article](https://support.google.com/merchants/answer/13674896) for more information. - "warranty": { # The warranty of the vehicle. # The [warranty](https://support.google.com/merchants/answer/15957626) of the product. + "warranty": { # The warranty of the product. # The [`warranty`](https://support.google.com/merchants/answer/18562485) of the product. "duration": "A String", # The warranty duration in units. Default is in months, can be overridden by the `duration_unit` field. "durationUnit": "A String", # The unit for the warranty duration. Assumed to be `MONTH` if equal to `WARRANTY_DURATION_UNIT_UNSPECIFIED`. "mileage": { # The mileage of the vehicle. # The warranty mileage (only applies to vehicles). @@ -1188,7 +1188,7 @@Method Details
], "vin": "A String", # The [Vehicle Identification Number (VIN)](https://support.google.com/google-ads/answer/14154510) of the vehicle. "virtualModelLink": "A String", # URL of the 3D image of the item. See the [Help Center article](https://support.google.com/merchants/answer/13674896) for more information. - "warranty": { # The warranty of the vehicle. # The [warranty](https://support.google.com/merchants/answer/15957626) of the product. + "warranty": { # The warranty of the product. # The [`warranty`](https://support.google.com/merchants/answer/18562485) of the product. "duration": "A String", # The warranty duration in units. Default is in months, can be overridden by the `duration_unit` field. "durationUnit": "A String", # The unit for the warranty duration. Assumed to be `MONTH` if equal to `WARRANTY_DURATION_UNIT_UNSPECIFIED`. "mileage": { # The mileage of the vehicle. # The warranty mileage (only applies to vehicles). @@ -1734,7 +1734,7 @@Method Details
], "vin": "A String", # The [Vehicle Identification Number (VIN)](https://support.google.com/google-ads/answer/14154510) of the vehicle. "virtualModelLink": "A String", # URL of the 3D image of the item. See the [Help Center article](https://support.google.com/merchants/answer/13674896) for more information. - "warranty": { # The warranty of the vehicle. # The [warranty](https://support.google.com/merchants/answer/15957626) of the product. + "warranty": { # The warranty of the product. # The [`warranty`](https://support.google.com/merchants/answer/18562485) of the product. "duration": "A String", # The warranty duration in units. Default is in months, can be overridden by the `duration_unit` field. "durationUnit": "A String", # The unit for the warranty duration. Assumed to be `MONTH` if equal to `WARRANTY_DURATION_UNIT_UNSPECIFIED`. "mileage": { # The mileage of the vehicle. # The warranty mileage (only applies to vehicles). @@ -2280,7 +2280,7 @@Method Details
], "vin": "A String", # The [Vehicle Identification Number (VIN)](https://support.google.com/google-ads/answer/14154510) of the vehicle. "virtualModelLink": "A String", # URL of the 3D image of the item. See the [Help Center article](https://support.google.com/merchants/answer/13674896) for more information. - "warranty": { # The warranty of the vehicle. # The [warranty](https://support.google.com/merchants/answer/15957626) of the product. + "warranty": { # The warranty of the product. # The [`warranty`](https://support.google.com/merchants/answer/18562485) of the product. "duration": "A String", # The warranty duration in units. Default is in months, can be overridden by the `duration_unit` field. "durationUnit": "A String", # The unit for the warranty duration. Assumed to be `MONTH` if equal to `WARRANTY_DURATION_UNIT_UNSPECIFIED`. "mileage": { # The mileage of the vehicle. # The warranty mileage (only applies to vehicles). diff --git a/docs/dyn/merchantapi_products_v1.accounts.products.html b/docs/dyn/merchantapi_products_v1.accounts.products.html index 49b1d2c1ea..bef7d10fe4 100644 --- a/docs/dyn/merchantapi_products_v1.accounts.products.html +++ b/docs/dyn/merchantapi_products_v1.accounts.products.html @@ -643,7 +643,7 @@Method Details
], "vin": "A String", # The [Vehicle Identification Number (VIN)](https://support.google.com/google-ads/answer/14154510) of the vehicle. "virtualModelLink": "A String", # URL of the 3D image of the item. See the [Help Center article](https://support.google.com/merchants/answer/13674896) for more information. - "warranty": { # The warranty of the vehicle. # The [warranty](https://support.google.com/merchants/answer/15957626) of the product. + "warranty": { # The warranty of the product. # The [`warranty`](https://support.google.com/merchants/answer/18562485) of the product. "duration": "A String", # The warranty duration in units. Default is in months, can be overridden by the `duration_unit` field. "durationUnit": "A String", # The unit for the warranty duration. Assumed to be `MONTH` if equal to `WARRANTY_DURATION_UNIT_UNSPECIFIED`. "mileage": { # The mileage of the vehicle. # The warranty mileage (only applies to vehicles). @@ -1247,7 +1247,7 @@Method Details
], "vin": "A String", # The [Vehicle Identification Number (VIN)](https://support.google.com/google-ads/answer/14154510) of the vehicle. "virtualModelLink": "A String", # URL of the 3D image of the item. See the [Help Center article](https://support.google.com/merchants/answer/13674896) for more information. - "warranty": { # The warranty of the vehicle. # The [warranty](https://support.google.com/merchants/answer/15957626) of the product. + "warranty": { # The warranty of the product. # The [`warranty`](https://support.google.com/merchants/answer/18562485) of the product. "duration": "A String", # The warranty duration in units. Default is in months, can be overridden by the `duration_unit` field. "durationUnit": "A String", # The unit for the warranty duration. Assumed to be `MONTH` if equal to `WARRANTY_DURATION_UNIT_UNSPECIFIED`. "mileage": { # The mileage of the vehicle. # The warranty mileage (only applies to vehicles). diff --git a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html index 4781a12253..c927c91bd5 100644 --- a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html @@ -137,7 +137,6 @@Method Details
"cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service}. Mutually exclusive with worker_pool_uri. "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} - "workerPoolUri": "A String", # Output only. The URI of the worker pool that the revision belongs to. The format is: projects/{project}/locations/{location}/workerPools/{workerPool}. Mutually exclusive with service_uri. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "dmsPrivateConnection": "A String", # A [DMS Private Connection](https://docs.cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. @@ -979,7 +978,6 @@Method Details
"cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service}. Mutually exclusive with worker_pool_uri. "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} - "workerPoolUri": "A String", # Output only. The URI of the worker pool that the revision belongs to. The format is: projects/{project}/locations/{location}/workerPools/{workerPool}. Mutually exclusive with service_uri. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "dmsPrivateConnection": "A String", # A [DMS Private Connection](https://docs.cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. @@ -1096,7 +1094,6 @@Method Details
"cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service}. Mutually exclusive with worker_pool_uri. "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} - "workerPoolUri": "A String", # Output only. The URI of the worker pool that the revision belongs to. The format is: projects/{project}/locations/{location}/workerPools/{workerPool}. Mutually exclusive with service_uri. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "dmsPrivateConnection": "A String", # A [DMS Private Connection](https://docs.cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. @@ -1938,7 +1935,6 @@Method Details
"cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service}. Mutually exclusive with worker_pool_uri. "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} - "workerPoolUri": "A String", # Output only. The URI of the worker pool that the revision belongs to. The format is: projects/{project}/locations/{location}/workerPools/{workerPool}. Mutually exclusive with service_uri. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "dmsPrivateConnection": "A String", # A [DMS Private Connection](https://docs.cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. @@ -2046,7 +2042,6 @@Method Details
"cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service}. Mutually exclusive with worker_pool_uri. "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} - "workerPoolUri": "A String", # Output only. The URI of the worker pool that the revision belongs to. The format is: projects/{project}/locations/{location}/workerPools/{workerPool}. Mutually exclusive with service_uri. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "dmsPrivateConnection": "A String", # A [DMS Private Connection](https://docs.cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. @@ -2888,7 +2883,6 @@Method Details
"cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service}. Mutually exclusive with worker_pool_uri. "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} - "workerPoolUri": "A String", # Output only. The URI of the worker pool that the revision belongs to. The format is: projects/{project}/locations/{location}/workerPools/{workerPool}. Mutually exclusive with service_uri. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "dmsPrivateConnection": "A String", # A [DMS Private Connection](https://docs.cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. @@ -2955,7 +2949,6 @@Method Details
"cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service}. Mutually exclusive with worker_pool_uri. "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} - "workerPoolUri": "A String", # Output only. The URI of the worker pool that the revision belongs to. The format is: projects/{project}/locations/{location}/workerPools/{workerPool}. Mutually exclusive with service_uri. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "dmsPrivateConnection": "A String", # A [DMS Private Connection](https://docs.cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. @@ -3797,7 +3790,6 @@Method Details
"cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service}. Mutually exclusive with worker_pool_uri. "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} - "workerPoolUri": "A String", # Output only. The URI of the worker pool that the revision belongs to. The format is: projects/{project}/locations/{location}/workerPools/{workerPool}. Mutually exclusive with service_uri. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "dmsPrivateConnection": "A String", # A [DMS Private Connection](https://docs.cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html index 8b97ee2687..539caea368 100644 --- a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html @@ -137,7 +137,6 @@Method Details
"cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service}. Mutually exclusive with worker_pool_uri. "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} - "workerPoolUri": "A String", # Output only. The URI of the worker pool that the revision belongs to. The format is: projects/{project}/locations/{location}/workerPools/{workerPool}. Mutually exclusive with service_uri. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "datastreamPrivateConnection": "A String", # A [Datastream Private Connection](https://docs.cloud.google.com/datastream/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. @@ -980,7 +979,6 @@Method Details
"cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service}. Mutually exclusive with worker_pool_uri. "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} - "workerPoolUri": "A String", # Output only. The URI of the worker pool that the revision belongs to. The format is: projects/{project}/locations/{location}/workerPools/{workerPool}. Mutually exclusive with service_uri. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "datastreamPrivateConnection": "A String", # A [Datastream Private Connection](https://docs.cloud.google.com/datastream/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. @@ -1098,7 +1096,6 @@Method Details
"cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service}. Mutually exclusive with worker_pool_uri. "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} - "workerPoolUri": "A String", # Output only. The URI of the worker pool that the revision belongs to. The format is: projects/{project}/locations/{location}/workerPools/{workerPool}. Mutually exclusive with service_uri. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "datastreamPrivateConnection": "A String", # A [Datastream Private Connection](https://docs.cloud.google.com/datastream/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. @@ -1941,7 +1938,6 @@Method Details
"cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service}. Mutually exclusive with worker_pool_uri. "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} - "workerPoolUri": "A String", # Output only. The URI of the worker pool that the revision belongs to. The format is: projects/{project}/locations/{location}/workerPools/{workerPool}. Mutually exclusive with service_uri. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "datastreamPrivateConnection": "A String", # A [Datastream Private Connection](https://docs.cloud.google.com/datastream/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. @@ -2050,7 +2046,6 @@Method Details
"cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service}. Mutually exclusive with worker_pool_uri. "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} - "workerPoolUri": "A String", # Output only. The URI of the worker pool that the revision belongs to. The format is: projects/{project}/locations/{location}/workerPools/{workerPool}. Mutually exclusive with service_uri. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "datastreamPrivateConnection": "A String", # A [Datastream Private Connection](https://docs.cloud.google.com/datastream/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. @@ -2893,7 +2888,6 @@Method Details
"cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service}. Mutually exclusive with worker_pool_uri. "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} - "workerPoolUri": "A String", # Output only. The URI of the worker pool that the revision belongs to. The format is: projects/{project}/locations/{location}/workerPools/{workerPool}. Mutually exclusive with service_uri. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "datastreamPrivateConnection": "A String", # A [Datastream Private Connection](https://docs.cloud.google.com/datastream/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. @@ -2961,7 +2955,6 @@Method Details
"cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service}. Mutually exclusive with worker_pool_uri. "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} - "workerPoolUri": "A String", # Output only. The URI of the worker pool that the revision belongs to. The format is: projects/{project}/locations/{location}/workerPools/{workerPool}. Mutually exclusive with service_uri. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "datastreamPrivateConnection": "A String", # A [Datastream Private Connection](https://docs.cloud.google.com/datastream/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. @@ -3804,7 +3797,6 @@Method Details
"cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service}. Mutually exclusive with worker_pool_uri. "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} - "workerPoolUri": "A String", # Output only. The URI of the worker pool that the revision belongs to. The format is: projects/{project}/locations/{location}/workerPools/{workerPool}. Mutually exclusive with service_uri. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "datastreamPrivateConnection": "A String", # A [Datastream Private Connection](https://docs.cloud.google.com/datastream/docs/reference/rest/v1/projects.locations.privateConnections) name format: projects/{project}/locations/{location}/privateConnections/{privateConnection}. diff --git a/docs/dyn/networksecurity_v1.projects.locations.serverTlsPolicies.html b/docs/dyn/networksecurity_v1.projects.locations.serverTlsPolicies.html index 1a41c989bd..8733f1491a 100644 --- a/docs/dyn/networksecurity_v1.projects.locations.serverTlsPolicies.html +++ b/docs/dyn/networksecurity_v1.projects.locations.serverTlsPolicies.html @@ -138,6 +138,9 @@Method Details
}, ], "clientValidationMode": "A String", # When the client presents an invalid certificate or no certificate to the load balancer, the `client_validation_mode` specifies how the client connection is handled. Required if the policy is to be used with the Application Load Balancers. For Traffic Director it must be empty. + "clientValidationRelaxations": [ # A list of validation relaxations to apply when `client_validation_mode` is set to ALLOW_VALIDATION_RELAXATIONS. + "A String", + ], "clientValidationTrustConfig": "A String", # Reference to the TrustConfig from certificatemanager.googleapis.com namespace. If specified, the chain validation will be performed against certificates configured in the given TrustConfig. Allowed only if the policy is to be used with Application Load Balancers. }, "name": "A String", # Required. Name of the ServerTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}` @@ -250,6 +253,9 @@Method Details
}, ], "clientValidationMode": "A String", # When the client presents an invalid certificate or no certificate to the load balancer, the `client_validation_mode` specifies how the client connection is handled. Required if the policy is to be used with the Application Load Balancers. For Traffic Director it must be empty. + "clientValidationRelaxations": [ # A list of validation relaxations to apply when `client_validation_mode` is set to ALLOW_VALIDATION_RELAXATIONS. + "A String", + ], "clientValidationTrustConfig": "A String", # Reference to the TrustConfig from certificatemanager.googleapis.com namespace. If specified, the chain validation will be performed against certificates configured in the given TrustConfig. Allowed only if the policy is to be used with Application Load Balancers. }, "name": "A String", # Required. Name of the ServerTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}` @@ -352,6 +358,9 @@Method Details
}, ], "clientValidationMode": "A String", # When the client presents an invalid certificate or no certificate to the load balancer, the `client_validation_mode` specifies how the client connection is handled. Required if the policy is to be used with the Application Load Balancers. For Traffic Director it must be empty. + "clientValidationRelaxations": [ # A list of validation relaxations to apply when `client_validation_mode` is set to ALLOW_VALIDATION_RELAXATIONS. + "A String", + ], "clientValidationTrustConfig": "A String", # Reference to the TrustConfig from certificatemanager.googleapis.com namespace. If specified, the chain validation will be performed against certificates configured in the given TrustConfig. Allowed only if the policy is to be used with Application Load Balancers. }, "name": "A String", # Required. Name of the ServerTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}` @@ -414,6 +423,9 @@Method Details
}, ], "clientValidationMode": "A String", # When the client presents an invalid certificate or no certificate to the load balancer, the `client_validation_mode` specifies how the client connection is handled. Required if the policy is to be used with the Application Load Balancers. For Traffic Director it must be empty. + "clientValidationRelaxations": [ # A list of validation relaxations to apply when `client_validation_mode` is set to ALLOW_VALIDATION_RELAXATIONS. + "A String", + ], "clientValidationTrustConfig": "A String", # Reference to the TrustConfig from certificatemanager.googleapis.com namespace. If specified, the chain validation will be performed against certificates configured in the given TrustConfig. Allowed only if the policy is to be used with Application Load Balancers. }, "name": "A String", # Required. Name of the ServerTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}` diff --git a/docs/dyn/networksecurity_v1beta1.projects.locations.serverTlsPolicies.html b/docs/dyn/networksecurity_v1beta1.projects.locations.serverTlsPolicies.html index 295c525d6f..4219dac8d8 100644 --- a/docs/dyn/networksecurity_v1beta1.projects.locations.serverTlsPolicies.html +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.serverTlsPolicies.html @@ -138,6 +138,9 @@Method Details
}, ], "clientValidationMode": "A String", # When the client presents an invalid certificate or no certificate to the load balancer, the `client_validation_mode` specifies how the client connection is handled. Required if the policy is to be used with the Application Load Balancers. For Traffic Director it must be empty. + "clientValidationRelaxations": [ # A list of validation relaxations to apply when `client_validation_mode` is set to ALLOW_VALIDATION_RELAXATIONS. + "A String", + ], "clientValidationTrustConfig": "A String", # Reference to the TrustConfig from certificatemanager.googleapis.com namespace. If specified, the chain validation will be performed against certificates configured in the given TrustConfig. Allowed only if the policy is to be used with Application Load Balancers. }, "name": "A String", # Required. Name of the ServerTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}` @@ -250,6 +253,9 @@Method Details
}, ], "clientValidationMode": "A String", # When the client presents an invalid certificate or no certificate to the load balancer, the `client_validation_mode` specifies how the client connection is handled. Required if the policy is to be used with the Application Load Balancers. For Traffic Director it must be empty. + "clientValidationRelaxations": [ # A list of validation relaxations to apply when `client_validation_mode` is set to ALLOW_VALIDATION_RELAXATIONS. + "A String", + ], "clientValidationTrustConfig": "A String", # Reference to the TrustConfig from certificatemanager.googleapis.com namespace. If specified, the chain validation will be performed against certificates configured in the given TrustConfig. Allowed only if the policy is to be used with Application Load Balancers. }, "name": "A String", # Required. Name of the ServerTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}` @@ -352,6 +358,9 @@Method Details
}, ], "clientValidationMode": "A String", # When the client presents an invalid certificate or no certificate to the load balancer, the `client_validation_mode` specifies how the client connection is handled. Required if the policy is to be used with the Application Load Balancers. For Traffic Director it must be empty. + "clientValidationRelaxations": [ # A list of validation relaxations to apply when `client_validation_mode` is set to ALLOW_VALIDATION_RELAXATIONS. + "A String", + ], "clientValidationTrustConfig": "A String", # Reference to the TrustConfig from certificatemanager.googleapis.com namespace. If specified, the chain validation will be performed against certificates configured in the given TrustConfig. Allowed only if the policy is to be used with Application Load Balancers. }, "name": "A String", # Required. Name of the ServerTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}` @@ -414,6 +423,9 @@Method Details
}, ], "clientValidationMode": "A String", # When the client presents an invalid certificate or no certificate to the load balancer, the `client_validation_mode` specifies how the client connection is handled. Required if the policy is to be used with the Application Load Balancers. For Traffic Director it must be empty. + "clientValidationRelaxations": [ # A list of validation relaxations to apply when `client_validation_mode` is set to ALLOW_VALIDATION_RELAXATIONS. + "A String", + ], "clientValidationTrustConfig": "A String", # Reference to the TrustConfig from certificatemanager.googleapis.com namespace. If specified, the chain validation will be performed against certificates configured in the given TrustConfig. Allowed only if the policy is to be used with Application Load Balancers. }, "name": "A String", # Required. Name of the ServerTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}` diff --git a/docs/dyn/notebooks_v2.projects.locations.instances.html b/docs/dyn/notebooks_v2.projects.locations.instances.html index 7ba8969c52..960a6d5a32 100644 --- a/docs/dyn/notebooks_v2.projects.locations.instances.html +++ b/docs/dyn/notebooks_v2.projects.locations.instances.html @@ -270,6 +270,7 @@Method Details
"externalIp": "A String", # Optional. An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. }, ], + "internalIp": "A String", # Optional. An internal IP address associated with this instance. Specify an unused static internal IP address available to the subnet this instance is in, or leave this field undefined to use an IP from the subnet's ephemeral range. "network": "A String", # Optional. The name of the VPC that this VM instance is in. Format: `projects/{project_id}/global/networks/{network_id}` "nicType": "A String", # Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. "subnet": "A String", # Optional. The name of the subnet that this VM instance is in. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` @@ -304,6 +305,7 @@Method Details
"vmImage": { # Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM. # Optional. Use a Compute Engine VM image to start the notebook instance. "family": "A String", # Optional. Use this VM image family to find the image; the newest image in this family will be used. "imageDescription": "A String", # Output only. A human-readable description of the image running on the instance (for example, "Debian 11, Python 3.10"), derived at read time from the image release configuration (the source of truth). Set to "Custom" for unrecognized boot-disk images. + "imageId": "A String", # Output only. The ID of the specific Compute Engine VM image the instance is currently running (for example, "workbench-instances-2603-20260918-2130-rc0"). "name": "A String", # Optional. Use VM image name to find the image. "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}` }, @@ -557,6 +559,7 @@Method Details
"externalIp": "A String", # Optional. An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. }, ], + "internalIp": "A String", # Optional. An internal IP address associated with this instance. Specify an unused static internal IP address available to the subnet this instance is in, or leave this field undefined to use an IP from the subnet's ephemeral range. "network": "A String", # Optional. The name of the VPC that this VM instance is in. Format: `projects/{project_id}/global/networks/{network_id}` "nicType": "A String", # Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. "subnet": "A String", # Optional. The name of the subnet that this VM instance is in. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` @@ -591,6 +594,7 @@Method Details
"vmImage": { # Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM. # Optional. Use a Compute Engine VM image to start the notebook instance. "family": "A String", # Optional. Use this VM image family to find the image; the newest image in this family will be used. "imageDescription": "A String", # Output only. A human-readable description of the image running on the instance (for example, "Debian 11, Python 3.10"), derived at read time from the image release configuration (the source of truth). Set to "Custom" for unrecognized boot-disk images. + "imageId": "A String", # Output only. The ID of the specific Compute Engine VM image the instance is currently running (for example, "workbench-instances-2603-20260918-2130-rc0"). "name": "A String", # Optional. Use VM image name to find the image. "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}` }, @@ -779,6 +783,7 @@Method Details
"externalIp": "A String", # Optional. An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. }, ], + "internalIp": "A String", # Optional. An internal IP address associated with this instance. Specify an unused static internal IP address available to the subnet this instance is in, or leave this field undefined to use an IP from the subnet's ephemeral range. "network": "A String", # Optional. The name of the VPC that this VM instance is in. Format: `projects/{project_id}/global/networks/{network_id}` "nicType": "A String", # Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. "subnet": "A String", # Optional. The name of the subnet that this VM instance is in. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` @@ -813,6 +818,7 @@Method Details
"vmImage": { # Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM. # Optional. Use a Compute Engine VM image to start the notebook instance. "family": "A String", # Optional. Use this VM image family to find the image; the newest image in this family will be used. "imageDescription": "A String", # Output only. A human-readable description of the image running on the instance (for example, "Debian 11, Python 3.10"), derived at read time from the image release configuration (the source of truth). Set to "Custom" for unrecognized boot-disk images. + "imageId": "A String", # Output only. The ID of the specific Compute Engine VM image the instance is currently running (for example, "workbench-instances-2603-20260918-2130-rc0"). "name": "A String", # Optional. Use VM image name to find the image. "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}` }, @@ -937,6 +943,7 @@Method Details
"externalIp": "A String", # Optional. An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. }, ], + "internalIp": "A String", # Optional. An internal IP address associated with this instance. Specify an unused static internal IP address available to the subnet this instance is in, or leave this field undefined to use an IP from the subnet's ephemeral range. "network": "A String", # Optional. The name of the VPC that this VM instance is in. Format: `projects/{project_id}/global/networks/{network_id}` "nicType": "A String", # Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. "subnet": "A String", # Optional. The name of the subnet that this VM instance is in. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` @@ -971,6 +978,7 @@Method Details
"vmImage": { # Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM. # Optional. Use a Compute Engine VM image to start the notebook instance. "family": "A String", # Optional. Use this VM image family to find the image; the newest image in this family will be used. "imageDescription": "A String", # Output only. A human-readable description of the image running on the instance (for example, "Debian 11, Python 3.10"), derived at read time from the image release configuration (the source of truth). Set to "Custom" for unrecognized boot-disk images. + "imageId": "A String", # Output only. The ID of the specific Compute Engine VM image the instance is currently running (for example, "workbench-instances-2603-20260918-2130-rc0"). "name": "A String", # Optional. Use VM image name to find the image. "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}` }, diff --git a/docs/dyn/ondemandscanning_v1.projects.locations.scans.html b/docs/dyn/ondemandscanning_v1.projects.locations.scans.html index 9bb0a3ff4a..ac55f498e3 100644 --- a/docs/dyn/ondemandscanning_v1.projects.locations.scans.html +++ b/docs/dyn/ondemandscanning_v1.projects.locations.scans.html @@ -136,6 +136,12 @@Method Details
{ # Indicates the location at which a package was found. "filePath": "A String", # For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file. "layerDetails": { # Details about the layer a package was found in. + "attributes": [ # Attributes attached to this layer by plugins. + { # An attribute attached to a layer by a plugin. + "plugin": "A String", # The name of the plugin that generated this attribute. + "value": "A String", # The value of the attribute, with a meaning defined by the plugin. + }, + ], "baseImages": [ # The base images the layer is found within. { # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. @@ -161,6 +167,12 @@Method Details
}, ], "layerDetails": { # Details about the layer a package was found in. # Deprecated: Layer details are captured per file location in FileLocation.layer_details. Top-level layer details is not persisted. + "attributes": [ # Attributes attached to this layer by plugins. + { # An attribute attached to a layer by a plugin. + "plugin": "A String", # The name of the plugin that generated this attribute. + "value": "A String", # The value of the attribute, with a meaning defined by the plugin. + }, + ], "baseImages": [ # The base images the layer is found within. { # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. diff --git a/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.html b/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.html index 2cb4175a32..e573566fd1 100644 --- a/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.html +++ b/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.html @@ -135,6 +135,12 @@Method Details
{ # Indicates the location at which a package was found. "filePath": "A String", # For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file. "layerDetails": { # Details about the layer a package was found in. + "attributes": [ # Attributes attached to this layer by plugins. + { # An attribute attached to a layer by a plugin. + "plugin": "A String", # The name of the plugin that generated this attribute. + "value": "A String", # The value of the attribute, with a meaning defined by the plugin. + }, + ], "baseImages": [ # The base images the layer is found within. { # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. @@ -160,6 +166,12 @@Method Details
}, ], "layerDetails": { # Details about the layer a package was found in. # Deprecated: Layer details are captured per file location in FileLocation.layer_details. Top-level layer details is not persisted. + "attributes": [ # Attributes attached to this layer by plugins. + { # An attribute attached to a layer by a plugin. + "plugin": "A String", # The name of the plugin that generated this attribute. + "value": "A String", # The value of the attribute, with a meaning defined by the plugin. + }, + ], "baseImages": [ # The base images the layer is found within. { # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. diff --git a/docs/dyn/oracledatabase_v1.projects.locations.autonomousDatabases.html b/docs/dyn/oracledatabase_v1.projects.locations.autonomousDatabases.html index b0352f93d5..959e82175d 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.autonomousDatabases.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.autonomousDatabases.html @@ -138,8 +138,8 @@Method Details
The object takes the form of: { # Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/ - "adminPassword": "A String", # Optional. Immutable. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. - "adminPasswordSecretVersion": "A String", # Optional. Immutable. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. + "adminPassword": "A String", # Optional. Input only. Immutable. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. + "adminPasswordSecretVersion": "A String", # Optional. Input only. Immutable. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. "cidr": "A String", # Optional. Immutable. The subnet CIDR range for the Autonomous Database. "createTime": "A String", # Output only. The date and time that the Autonomous Database was created. "database": "A String", # Optional. Immutable. The name of the Autonomous Database. The database name must be unique in the project. The name must begin with a letter and can contain a maximum of 30 alphanumeric characters. @@ -473,8 +473,8 @@Method Details
An object of the form: { # Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/ - "adminPassword": "A String", # Optional. Immutable. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. - "adminPasswordSecretVersion": "A String", # Optional. Immutable. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. + "adminPassword": "A String", # Optional. Input only. Immutable. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. + "adminPasswordSecretVersion": "A String", # Optional. Input only. Immutable. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. "cidr": "A String", # Optional. Immutable. The subnet CIDR range for the Autonomous Database. "createTime": "A String", # Output only. The date and time that the Autonomous Database was created. "database": "A String", # Optional. Immutable. The name of the Autonomous Database. The database name must be unique in the project. The name must begin with a letter and can contain a maximum of 30 alphanumeric characters. @@ -702,8 +702,8 @@Method Details
{ # The response for `AutonomousDatabase.List`. "autonomousDatabases": [ # The list of Autonomous Databases. { # Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/ - "adminPassword": "A String", # Optional. Immutable. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. - "adminPasswordSecretVersion": "A String", # Optional. Immutable. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. + "adminPassword": "A String", # Optional. Input only. Immutable. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. + "adminPasswordSecretVersion": "A String", # Optional. Input only. Immutable. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. "cidr": "A String", # Optional. Immutable. The subnet CIDR range for the Autonomous Database. "createTime": "A String", # Output only. The date and time that the Autonomous Database was created. "database": "A String", # Optional. Immutable. The name of the Autonomous Database. The database name must be unique in the project. The name must begin with a letter and can contain a maximum of 30 alphanumeric characters. @@ -916,8 +916,8 @@Method Details
The object takes the form of: { # Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/ - "adminPassword": "A String", # Optional. Immutable. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. - "adminPasswordSecretVersion": "A String", # Optional. Immutable. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. + "adminPassword": "A String", # Optional. Input only. Immutable. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. + "adminPasswordSecretVersion": "A String", # Optional. Input only. Immutable. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated. "cidr": "A String", # Optional. Immutable. The subnet CIDR range for the Autonomous Database. "createTime": "A String", # Output only. The date and time that the Autonomous Database was created. "database": "A String", # Optional. Immutable. The name of the Autonomous Database. The database name must be unique in the project. The name must begin with a letter and can contain a maximum of 30 alphanumeric characters. diff --git a/docs/dyn/oracledatabase_v1.projects.locations.cloudExadataInfrastructures.html b/docs/dyn/oracledatabase_v1.projects.locations.cloudExadataInfrastructures.html index cb72b0bf4e..e388f9a291 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.cloudExadataInfrastructures.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.cloudExadataInfrastructures.html @@ -100,6 +100,9 @@Instance Methods
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 parameters of a single Exadata Infrastructure.
Method Details
+close()@@ -161,14 +164,14 @@Method Details
{ # Represents CloudExadataInfrastructure resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudExadataInfrastructure/ "createTime": "A String", # Output only. The date and time that the Exadata Infrastructure was created. - "displayName": "A String", # Optional. User friendly name for this resource. + "displayName": "A String", # Optional. Immutable. User friendly name for this resource. "entitlementId": "A String", # Output only. Entitlement ID of the private offer against which this infrastructure resource is provisioned. - "gcpOracleZone": "A String", # Optional. The GCP Oracle zone where Oracle Exadata Infrastructure is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability. + "gcpOracleZone": "A String", # Optional. Immutable. The GCP Oracle zone where Oracle Exadata Infrastructure is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability. "labels": { # Optional. Labels or tags associated with the resource. "a_key": "A String", }, "name": "A String", # Identifier. The name of the Exadata Infrastructure resource with the format: projects/{project}/locations/{region}/cloudExadataInfrastructures/{cloud_exadata_infrastructure} - "properties": { # Various properties of Exadata Infrastructure. # Optional. Various properties of the infra. + "properties": { # Various properties of Exadata Infrastructure. # Optional. Immutable. Various properties of the infra. "activatedStorageCount": 42, # Output only. The requested number of additional storage servers activated for the Exadata Infrastructure. "additionalStorageCount": 42, # Output only. The requested number of additional storage servers for the Exadata Infrastructure. "availableStorageSizeGb": 42, # Output only. The available storage can be allocated to the Exadata Infrastructure resource, in gigabytes (GB). @@ -314,14 +317,14 @@Method Details
{ # Represents CloudExadataInfrastructure resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudExadataInfrastructure/ "createTime": "A String", # Output only. The date and time that the Exadata Infrastructure was created. - "displayName": "A String", # Optional. User friendly name for this resource. + "displayName": "A String", # Optional. Immutable. User friendly name for this resource. "entitlementId": "A String", # Output only. Entitlement ID of the private offer against which this infrastructure resource is provisioned. - "gcpOracleZone": "A String", # Optional. The GCP Oracle zone where Oracle Exadata Infrastructure is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability. + "gcpOracleZone": "A String", # Optional. Immutable. The GCP Oracle zone where Oracle Exadata Infrastructure is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability. "labels": { # Optional. Labels or tags associated with the resource. "a_key": "A String", }, "name": "A String", # Identifier. The name of the Exadata Infrastructure resource with the format: projects/{project}/locations/{region}/cloudExadataInfrastructures/{cloud_exadata_infrastructure} - "properties": { # Various properties of Exadata Infrastructure. # Optional. Various properties of the infra. + "properties": { # Various properties of Exadata Infrastructure. # Optional. Immutable. Various properties of the infra. "activatedStorageCount": 42, # Output only. The requested number of additional storage servers activated for the Exadata Infrastructure. "additionalStorageCount": 42, # Output only. The requested number of additional storage servers for the Exadata Infrastructure. "availableStorageSizeGb": 42, # Output only. The available storage can be allocated to the Exadata Infrastructure resource, in gigabytes (GB). @@ -406,14 +409,14 @@Method Details
"cloudExadataInfrastructures": [ # The list of Exadata Infrastructures. { # Represents CloudExadataInfrastructure resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudExadataInfrastructure/ "createTime": "A String", # Output only. The date and time that the Exadata Infrastructure was created. - "displayName": "A String", # Optional. User friendly name for this resource. + "displayName": "A String", # Optional. Immutable. User friendly name for this resource. "entitlementId": "A String", # Output only. Entitlement ID of the private offer against which this infrastructure resource is provisioned. - "gcpOracleZone": "A String", # Optional. The GCP Oracle zone where Oracle Exadata Infrastructure is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability. + "gcpOracleZone": "A String", # Optional. Immutable. The GCP Oracle zone where Oracle Exadata Infrastructure is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability. "labels": { # Optional. Labels or tags associated with the resource. "a_key": "A String", }, "name": "A String", # Identifier. The name of the Exadata Infrastructure resource with the format: projects/{project}/locations/{region}/cloudExadataInfrastructures/{cloud_exadata_infrastructure} - "properties": { # Various properties of Exadata Infrastructure. # Optional. Various properties of the infra. + "properties": { # Various properties of Exadata Infrastructure. # Optional. Immutable. Various properties of the infra. "activatedStorageCount": 42, # Output only. The requested number of additional storage servers activated for the Exadata Infrastructure. "additionalStorageCount": 42, # Output only. The requested number of additional storage servers for the Exadata Infrastructure. "availableStorageSizeGb": 42, # Output only. The available storage can be allocated to the Exadata Infrastructure resource, in gigabytes (GB). @@ -496,4 +499,115 @@Method Details
++patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)+Updates the parameters of a single Exadata Infrastructure. + +Args: + name: string, Identifier. The name of the Exadata Infrastructure resource with the format: projects/{project}/locations/{region}/cloudExadataInfrastructures/{cloud_exadata_infrastructure} (required) + body: object, The request body. + The object takes the form of: + +{ # Represents CloudExadataInfrastructure resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudExadataInfrastructure/ + "createTime": "A String", # Output only. The date and time that the Exadata Infrastructure was created. + "displayName": "A String", # Optional. Immutable. User friendly name for this resource. + "entitlementId": "A String", # Output only. Entitlement ID of the private offer against which this infrastructure resource is provisioned. + "gcpOracleZone": "A String", # Optional. Immutable. The GCP Oracle zone where Oracle Exadata Infrastructure is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability. + "labels": { # Optional. Labels or tags associated with the resource. + "a_key": "A String", + }, + "name": "A String", # Identifier. The name of the Exadata Infrastructure resource with the format: projects/{project}/locations/{region}/cloudExadataInfrastructures/{cloud_exadata_infrastructure} + "properties": { # Various properties of Exadata Infrastructure. # Optional. Immutable. Various properties of the infra. + "activatedStorageCount": 42, # Output only. The requested number of additional storage servers activated for the Exadata Infrastructure. + "additionalStorageCount": 42, # Output only. The requested number of additional storage servers for the Exadata Infrastructure. + "availableStorageSizeGb": 42, # Output only. The available storage can be allocated to the Exadata Infrastructure resource, in gigabytes (GB). + "computeCount": 42, # Optional. The number of compute servers for the Exadata Infrastructure. + "computeModel": "A String", # Output only. The compute model of the Exadata Infrastructure. + "cpuCount": 42, # Output only. The number of enabled CPU cores. + "customerContacts": [ # Optional. The list of customer contacts. + { # The CustomerContact reference as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/CustomerContact + "email": "A String", # Required. The email address used by Oracle to send notifications regarding databases and infrastructure. + }, + ], + "dataStorageSizeTb": 3.14, # Output only. Size, in terabytes, of the DATA disk group. + "databaseServerType": "A String", # Optional. The database server type of the Exadata Infrastructure. + "dbNodeStorageSizeGb": 42, # Output only. The local node storage allocated in GBs. + "dbServerVersion": "A String", # Output only. The software version of the database servers (dom0) in the Exadata Infrastructure. + "exascaleConfig": { # Details of the Exascale configuration for the Exadata Infrastructure. # Output only. The Exascale configuration for the Exadata Infrastructure. + "availableStorageSizeGb": 42, # Output only. Available storage size for Exascale in GBs. + "availableVmStorageSizeGb": 42, # Output only. Available storage size for VM storage on Exascale in GBs. + "totalStorageSizeGb": 42, # Output only. Total storage size needed for Exascale in GBs. + "totalVmStorageSizeGb": 42, # Output only. Storage size needed for VM storage on Exascale in GBs. + }, + "maintenanceWindow": { # Maintenance window as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/MaintenanceWindow # Optional. Maintenance window for repair. + "customActionTimeoutMins": 42, # Optional. Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). + "daysOfWeek": [ # Optional. Days during the week when maintenance should be performed. + "A String", + ], + "hoursOfDay": [ # Optional. The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are: 0 - represents time slot 0:00 - 3:59 UTC 4 - represents time slot 4:00 - 7:59 UTC 8 - represents time slot 8:00 - 11:59 UTC 12 - represents time slot 12:00 - 15:59 UTC 16 - represents time slot 16:00 - 19:59 UTC 20 - represents time slot 20:00 - 23:59 UTC + 42, + ], + "isCustomActionTimeoutEnabled": True or False, # Optional. If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. + "leadTimeWeek": 42, # Optional. Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. + "months": [ # Optional. Months during the year when maintenance should be performed. + "A String", + ], + "patchingMode": "A String", # Optional. Cloud CloudExadataInfrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. + "preference": "A String", # Optional. The maintenance window scheduling preference. + "weeksOfMonth": [ # Optional. Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. + 42, + ], + }, + "maxCpuCount": 42, # Output only. The total number of CPU cores available. + "maxDataStorageTb": 3.14, # Output only. The total available DATA disk group size. + "maxDbNodeStorageSizeGb": 42, # Output only. The total local node storage available in GBs. + "maxMemoryGb": 42, # Output only. The total memory available in GBs. + "memorySizeGb": 42, # Output only. The memory allocated in GBs. + "monthlyDbServerVersion": "A String", # Output only. The monthly software version of the database servers (dom0) in the Exadata Infrastructure. Example: 20.1.15 + "monthlyStorageServerVersion": "A String", # Output only. The monthly software version of the storage servers (cells) in the Exadata Infrastructure. Example: 20.1.15 + "nextMaintenanceRunId": "A String", # Output only. The OCID of the next maintenance run. + "nextMaintenanceRunTime": "A String", # Output only. The time when the next maintenance run will occur. + "nextSecurityMaintenanceRunTime": "A String", # Output only. The time when the next security maintenance run will occur. + "ociUrl": "A String", # Output only. Deep link to the OCI console to view this resource. + "ocid": "A String", # Output only. OCID of created infra. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle + "shape": "A String", # Required. The shape of the Exadata Infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance. + "state": "A String", # Output only. The current lifecycle state of the Exadata Infrastructure. + "storageCount": 42, # Optional. The number of Cloud Exadata storage servers for the Exadata Infrastructure. + "storageServerType": "A String", # Optional. The storage server type of the Exadata Infrastructure. + "storageServerVersion": "A String", # Output only. The software version of the storage servers (cells) in the Exadata Infrastructure. + "totalStorageSizeGb": 42, # Optional. The total storage allocated to the Exadata Infrastructure resource, in gigabytes (GB). + }, +} + + 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 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 + 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. + }, +}+